home *** CD-ROM | disk | FTP | other *** search
/ User's Choice Windows CD / User's Choice Windows CD (CMS Software)(1993).iso / utility2 / wine02bx.zip / ETC / DOC < prev    next >
Text File  |  1993-03-28  |  234KB  |  5,834 lines
  1. Fmake-abbrev-table
  2. Create a new, empty abbrev table object.
  3.  
  4. arguments:()
  5. Fclear-abbrev-table
  6. Undefine all abbrevs in abbrev table TABLE, leaving it empty.
  7.  
  8. arguments:(table)
  9. Fdefine-abbrev
  10. Define an abbrev in TABLE named NAME, to expand to EXPANSION and call HOOK.
  11. NAME and EXPANSION are strings.
  12. To undefine an abbrev, define it with EXPANSION = nil.
  13. If HOOK is non-nil, it should be a function of no arguments;
  14. it is called after EXPANSION is inserted.
  15.  
  16. arguments:(table name expansion &optional hook count)
  17. Fdefine-global-abbrev
  18. Define ABBREV as a global abbreviation for EXPANSION.
  19.  
  20. arguments:(name expansion)
  21. Fdefine-mode-abbrev
  22. Define ABBREV as a mode-specific abbreviation for EXPANSION.
  23.  
  24. arguments:(name expansion)
  25. Fabbrev-symbol
  26. Return the symbol representing abbrev named ABBREV.
  27. This symbol's name is ABBREV, but it is not the canonical symbol of that name;
  28. it is interned in an abbrev-table rather than the normal obarray.
  29. The value is nil if that abbrev is not defined.
  30. Optional second arg TABLE is abbrev table to look it up in.
  31. The default is to try buffer's mode-specific abbrev table, then global table.
  32.  
  33. arguments:(abbrev &optional table)
  34. Fabbrev-expansion
  35. Return the string that ABBREV expands into in the current buffer.
  36. Optionally specify an abbrev table as second arg;
  37. then ABBREV is looked up in that table only.
  38.  
  39. arguments:(abbrev &optional table)
  40. Fexpand-abbrev
  41. Expand the abbrev before point, if there is an abbrev there.
  42. Effective when explicitly called even when `abbrev-mode' is nil.
  43. Returns t if expansion took place.
  44.  
  45. arguments:()
  46. Funexpand-abbrev
  47. Undo the expansion of the last abbrev that expanded.
  48. This differs from ordinary undo in that other editing done since then
  49. is not undone.
  50.  
  51. arguments:()
  52. Finsert-abbrev-table-description
  53. Insert before point a full description of abbrev table named NAME.
  54. NAME is a symbol whose value is an abbrev table.
  55. If optional 2nd arg HUMAN is non-nil, a human-readable description is inserted.
  56. Otherwise the description is an expression,
  57. a call to `define-abbrev-table', which would
  58. define the abbrev table NAME exactly as it is currently defined.
  59.  
  60. arguments:(name &optional readable)
  61. Fdefine-abbrev-table
  62. Define TABNAME (a symbol) as an abbrev table name.
  63. Define abbrevs in it according to DEFINITIONS, which is a list of elements
  64. of the form (ABBREVNAME EXPANSION HOOK USECOUNT).
  65.  
  66. arguments:(tabname defns)
  67. Vabbrev-table-name-list
  68. List of symbols whose values are abbrev tables.Vglobal-abbrev-table
  69. The abbrev table whose abbrevs affect all buffers.
  70. Each buffer may also have a local abbrev table.
  71. If it does, the local table overrides the global one
  72. for any particular abbrev defined in both.Vfundamental-mode-abbrev-table
  73. The abbrev table of mode-specific abbrevs for Fundamental Mode.Vlast-abbrev
  74. The abbrev-symbol of the last abbrev expanded.  See `abbrev-symbol'.Vlast-abbrev-text
  75. The exact text of the last abbrev expanded.
  76. nil if the abbrev has already been unexpanded.Vlast-abbrev-location
  77. The location of the start of the last abbrev expanded.Vabbrev-start-location
  78. Buffer position for `expand-abbrev' to use as the start of the abbrev.
  79. nil means use the word before point as the abbrev.
  80. Calling `expand-abbrev' sets this to nil.Vabbrev-start-location-buffer
  81. Buffer that `abbrev-start-location' has been set for.
  82. Trying to expand an abbrev in any other buffer clears `abbrev-start-location'.Vabbrevs-changed
  83. Set non-nil by defining or altering any word abbrevs.
  84. This causes `save-some-buffers' to offer to save the abbrevs.Vabbrev-all-caps
  85. *Set non-nil means expand multi-word abbrevs all caps if abbrev was so.Vpre-abbrev-expand-hook
  86. Function or functions to be called before abbrev expansion is done.
  87. This is the first thing that `expand-abbrev' does, and so this may change
  88. the current abbrev table before abbrev lookup happens.Fcons
  89. Create a new cons, give it CAR and CDR as components, and return it.
  90.  
  91. arguments:(car cdr)
  92. Flist
  93. Return a newly created list with specified arguments as elements.
  94. Any number of arguments, even zero arguments, are allowed.
  95.  
  96. arguments: (&rest args)
  97. Fmake-list
  98. Return a newly created list of length LENGTH, with each element being INIT.
  99.  
  100. arguments:(length init)
  101. Fmake-vector
  102. Return a newly created vector of length LENGTH, with each element being INIT.
  103. See also the function `vector'.
  104.  
  105. arguments:(length init)
  106. Fvector
  107. Return a newly created vector with specified arguments as elements.
  108. Any number of arguments, even zero arguments, are allowed.
  109.  
  110. arguments: (&rest args)
  111. Fmake-byte-code
  112. Create a byte-code object with specified arguments as elements.
  113. At least four arguments are required; only six have any significance.
  114.  
  115. arguments: (arg1 arg2 arg3 arg4 &rest args)
  116. Fmake-symbol
  117. Return a newly allocated uninterned symbol whose name is NAME.
  118. Its value and function definition are void, and its property list is nil.
  119.  
  120. arguments:(str)
  121. Fmake-marker
  122. Return a newly allocated marker which does not point at any place.
  123.  
  124. arguments:()
  125. Fmake-string
  126. Return a newly created string of length LENGTH, with each element being INIT.
  127. Both LENGTH and INIT must be numbers.
  128.  
  129. arguments:(length init)
  130. Fpurecopy
  131. Make a copy of OBJECT in pure storage.
  132. Recursively copies contents of vectors and cons cells.
  133. Does not copy symbols.
  134.  
  135. arguments:(obj)
  136. Fgarbage-collect
  137. Reclaim storage for Lisp objects no longer needed.
  138. Returns info on amount of space in use:
  139.  ((USED-CONSES . FREE-CONSES) (USED-SYMS . FREE-SYMS)
  140.   (USED-MARKERS . FREE-MARKERS) USED-STRING-CHARS USED-VECTOR-SLOTS
  141.   (USED-FLOATS . FREE-FLOATS) (USED-EVENTS . FREE-EVENTS))
  142. Garbage collection happens automatically if you cons more than
  143. `gc-cons-threshold' bytes of Lisp data since previous garbage collection.
  144.  
  145. arguments:()
  146. Vgc-cons-threshold
  147. *Number of bytes of consing between garbage collections.
  148. Garbage collection can happen automatically once this many bytes have been
  149. allocated since the last garbage collection.  All data types count.
  150.  
  151. Garbage collection happens automatically when `eval' or `funcall' are
  152. called.  (Note that `funcall' is called implicitly.)
  153. By binding this temporarily to a large number, you can effectively
  154. prevent garbage collection during a part of the program.Vpure-bytes-used
  155. Number of bytes of sharable Lisp data allocated so far.Vdata-bytes-used
  156. Number of bytes of unshared memory allocated in this session.Vdata-bytes-free
  157. Number of bytes of unshared memory remaining available in this session.Vpurify-flag
  158. Non-nil means loading Lisp code in order to dump an executable.
  159. This means that certain objects should be allocated in shared (pure) space.Vundo-threshold
  160. Keep no more undo information once it exceeds this size.
  161. This threshold is applied when garbage collection happens.
  162. The size is counted as the number of bytes occupied,
  163. which includes both saved text and other data.Vundo-high-threshold
  164. Don't keep more than this much size of undo information.
  165. A command which pushes past this size is itself forgotten.
  166. This threshold is applied when garbage collection happens.
  167. The size is counted as the number of bytes occupied,
  168. which includes both saved text and other data.V   gc-currently-forbidden
  169. internal variable used to control undoFbuffer-list
  170. Return a list of all existing live buffers.
  171. The order is specific to the selected screen; if the optional SCREEN
  172. argument is provided, the ordering for that screen is returned instead.
  173. If the SCREEN argument is t, then the global (non-screen) ordering is
  174. returned instead.
  175.  
  176. arguments:(&optional screen)
  177. Fget-buffer
  178. Return the buffer named NAME (a string).
  179. If there is no live buffer named NAME, return nil.
  180. NAME may also be a buffer; if so, the value is that buffer.
  181.  
  182. arguments:(name)
  183. Fget-file-buffer
  184. Return the buffer visiting file FILENAME (a string).
  185. If there is no such live buffer, return nil.
  186.  
  187. arguments:(filename)
  188. Fget-buffer-create
  189. Return the buffer named NAME, or create such a buffer and return it.
  190. A new buffer is created if there is no live buffer named NAME.
  191. If NAME starts with a space, the new buffer does not keep undo information.
  192. If NAME is a buffer instead of a string, then it is the value returned.
  193. The value is never nil.
  194.  
  195. arguments:(name)
  196. Fgenerate-new-buffer-name
  197. Return a string that is the name of no existing buffer based on NAME.
  198. If there is no live buffer named NAME, then return NAME.
  199. Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
  200. until an unused name is found, and then return that name.
  201.  
  202. arguments:(name)
  203. Fbuffer-name
  204. Return the name of BUFFER, as a string.
  205. With no argument or nil as argument, return the name of the current buffer.
  206.  
  207. arguments:(&optional buffer)
  208. Fbuffer-file-name
  209. Return name of file BUFFER is visiting, or nil if none.
  210. No argument or nil as argument means use the current buffer.
  211.  
  212. arguments:(&optional buffer)
  213. Fbuffer-local-variables
  214. Return an alist of variables that are buffer-local in BUFFER.
  215. Each element looks like (SYMBOL . VALUE) and describes one variable.
  216. Note that storing new VALUEs in these elements doesn't change the variables.
  217. No argument or nil as argument means use current buffer as BUFFER.
  218.  
  219. arguments:(&optional buffer)
  220. Fbuffer-dedicated-screen
  221. Return the screen dedicated to this BUFFER, or nil if there is none.
  222. No argument or nil as argument means use current buffer as BUFFER.
  223.  
  224. arguments:(&optional buffer)
  225. Fset-buffer-dedicated-screen
  226. For this BUFFER, set the SCREEN dedicated to it.
  227. SCREEN must be a screen or nil.
  228.  
  229. arguments:(buffer screen)
  230. Fbuffer-modified-p
  231. Return t if BUFFER was modified since its file was last read or saved.
  232. No argument or nil as argument means use current buffer as BUFFER.
  233.  
  234. arguments:(&optional buffer)
  235. Fset-buffer-modified-p
  236. Mark current buffer as modified or unmodified according to FLAG.
  237. A non-nil FLAG means mark the buffer modified.
  238.  
  239. arguments:(flag)
  240. Fbuffer-modified-tick
  241. Return BUFFER's tick counter, incremented for each change in text.
  242. Each buffer has a tick counter which is incremented each time the text in
  243. that buffer is changed.  It wraps around occasionally.
  244. No argument or nil as argument means use current buffer as BUFFER.
  245.  
  246. arguments:(&optional buffer)
  247. Frename-buffer
  248. Change current buffer's name to NEWNAME (a string).
  249. If second arg DISTINGUISH is nil or omitted, it is an error if a
  250. buffer named NEWNAME already exists.
  251. If DISTINGUISH is non-nil, come up with a new name using
  252. `generate-new-buffer-name'.
  253. Return the name we actually gave the buffer.
  254. This does not change the name of the visited file (if any).
  255.  
  256. arguments:(name &optional distinguish)
  257. Fother-buffer
  258. Return most recently selected buffer other than BUFFER.
  259. Buffers not visible in windows are preferred to visible buffers.
  260. If no other buffer exists, the buffer `*scratch*' is returned.
  261. If BUFFER is omitted or nil, some interesting buffer is returned.
  262.  
  263. The ordering is for this screen; If second optional argument SCREEN
  264. is provided, then the ordering is for that screen.  If the second arg
  265. is t, then the global ordering is returned.
  266.  
  267. arguments:(&optional buffer screen)
  268. Fbuffer-disable-undo
  269. Make BUFFER stop keeping undo information.
  270. Any undo records it already has are discarded.
  271.  
  272. arguments:(buffer)
  273. Fbuffer-enable-undo
  274. Start keeping undo information for buffer BUFFER.
  275. No argument or nil as argument means do this for the current buffer.
  276.  
  277. arguments:(&optional buffer)
  278. Fkill-buffer
  279. Kill the buffer BUFFER.
  280. The argument may be a buffer or may be the name of a buffer.
  281. An argument of nil means kill the current buffer.
  282.  
  283. Value is t if the buffer is actually killed, nil if user says no.
  284.  
  285. The value of `kill-buffer-hook' (which may be local to that buffer),
  286. if not void, is a list of functions to be called, with no arguments,
  287. before the buffer is actually killed.  The buffer to be killed is current
  288. when the hook functions are called.
  289.  
  290. Any processes that have this buffer as the `process-buffer' are killed
  291. with `delete-process'.
  292.  
  293. arguments:(bufname)
  294. Fswitch-to-buffer
  295. Select buffer BUFFER in the current window.
  296. BUFFER may be a buffer or a buffer name.
  297. Optional second arg NORECORD non-nil means
  298. do not put this buffer at the front of the list of recently selected ones.
  299.  
  300. WARNING: This is NOT the way to work on another buffer temporarily
  301. within a Lisp program!  Use `set-buffer' instead.  That avoids messing with
  302. the window-buffer correspondences.
  303.  
  304. arguments:(bufname &optional norecord)
  305. Fpop-to-buffer
  306. Select buffer BUFFER in some window, preferably a different one.
  307. If BUFFER is nil, then some other buffer is chosen.
  308. If `pop-up-windows' is non-nil, windows can be split to do this.
  309. If optional second arg WINDOW is non-nil, insist on finding another
  310. window even if BUFFER is already visible in the selected window.
  311. If optional third arg is non-nil, it is the screen to pop to this
  312. buffer on.
  313.  
  314. arguments:(bufname &optional not_this_window_p on_screen)
  315. Fcurrent-buffer
  316. Return the current buffer as a Lisp object.
  317.  
  318. arguments:()
  319. Fset-buffer
  320. Make the buffer BUFFER current for editing operations.
  321. BUFFER may be a buffer or the name of an existing buffer.
  322. See also `save-excursion' when you want to make a buffer current temporarily.
  323. This function does not display the buffer, so its effect ends
  324. when the current command terminates.
  325. Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.
  326.  
  327. arguments:(bufname)
  328. Fbarf-if-buffer-read-only
  329. Signal a `buffer-read-only' error if the current buffer is read-only.
  330.  
  331. arguments:()
  332. Fbury-buffer
  333. Put BUFFER at the end of the list of all buffers.
  334. There it is the least likely candidate for `other-buffer' to return;
  335. thus, the least likely buffer for \[switch-to-buffer] to select by default.
  336.  
  337. arguments:(&optional buffer)
  338. Ferase-buffer
  339. Delete the entire contents of the current buffer.
  340. Any clipping restriction in effect (see `narrow-to-buffer') is removed,
  341. so the buffer is truly empty after this.
  342.  
  343. arguments:()
  344. Fkill-all-local-variables
  345. Switch to Fundamental mode by killing current buffer's local variables.
  346. Most local variable bindings are eliminated so that the default values
  347. become effective once more.  Also, the syntax table is set from
  348. `standard-syntax-table', the local keymap is set to nil,
  349. and the abbrev table from `fundamental-mode-abbrev-table'.
  350. This function also forces redisplay of the mode line.
  351.  
  352. Every function to select a new major mode starts by
  353. calling this function.
  354.  
  355. As a special exception, local variables whose names have
  356. a non-nil `permanent-local' property are not eliminated by this function.
  357.  
  358. arguments:()
  359. Fregion-fields
  360. Return list of fields overlapping a given portion of a buffer.
  361. The portion is specified by arguments START, END and BUFFER.
  362. BUFFER defaults to the current buffer.
  363. Optional 4th arg ERROR-CHECK non nil means just report an error
  364. if any protected fields overlap this portion.
  365.  
  366. arguments:(start end &optional buffer error_check)
  367. Vdefault-mode-line-format
  368. Default value of `mode-line-format' for buffers that don't override it.
  369. This is the same as (default-value 'mode-line-format).Vdefault-abbrev-mode
  370. Default value of `abbrev-mode' for buffers that do not override it.
  371. This is the same as (default-value 'abbrev-mode).Vdefault-ctl-arrow
  372. Default value of `ctl-arrow' for buffers that do not override it.
  373. This is the same as (default-value 'ctl-arrow).Vdefault-truncate-lines
  374. Default value of `truncate-lines' for buffers that do not override it.
  375. This is the same as (default-value 'truncate-lines).Vdefault-fill-column
  376. Default value of `fill-column' for buffers that do not override it.
  377. This is the same as (default-value 'fill-column).Vdefault-left-margin
  378. Default value of `left-margin' for buffers that do not override it.
  379. This is the same as (default-value 'left-margin).Vdefault-tab-width
  380. Default value of `tab-width' for buffers that do not override it.
  381. This is the same as (default-value 'tab-width).Vdefault-case-fold-search
  382. Default value of `case-fold-search' for buffers that don't override it.
  383. This is the same as (default-value 'case-fold-search).Vdefault-file-type
  384. Default value of `file-type' for buffers that do not override it.
  385. This is the same as (default-value 'file-type).Vmode-line-format
  386. Template for displaying mode line for current buffer.
  387. Each buffer has its own value of this variable.
  388. Value may be a string, a symbol or a list or cons cell.
  389. For a symbol, its value is used (but it is ignored if t or nil).
  390.  A string appearing directly as the value of a symbol is processed verbatim
  391.  in that the %-constructs below are not recognized.
  392. For a list whose car is a symbol, the symbol's value is taken,
  393.  and if that is non-nil, the cadr of the list is processed recursively.
  394.  Otherwise, the caddr of the list (if there is one) is processed.
  395. For a list whose car is a string or list, each element is processed
  396.  recursively and the results are effectively concatenated.
  397. For a list whose car is an integer, the cdr of the list is processed
  398.   and padded (if the number is positive) or truncated (if negative)
  399.   to the width specified by that number.
  400. A string is printed verbatim in the mode line except for %-constructs:
  401.   (%-constructs are allowed when the string is the entire mode-line-format
  402.    or when it is found in a cons-cell or a list)
  403.   %b -- print buffer name.      %f -- print visited file name.
  404.   %* -- print *, % or hyphen.   %m -- print value of mode-name (obsolete).
  405.   %s -- print process status.   %M -- print value of global-mode-string. (obs)
  406.   %S -- print name of selected screen (only meaningful under X Windows).
  407.   %p -- print percent of buffer above top of window, or top, bot or all.
  408.   %n -- print Narrow if appropriate.
  409.   %[ -- print one [ for each recursive editing level.  %] similar.
  410.   %% -- print %.   %- -- print infinitely many dashes.
  411. Decimal digits after the % specify field width to which to pad.Vdefault-major-mode
  412. *Major mode for new buffers.  Defaults to `fundamental-mode'.
  413. nil here means use current buffer's major mode.Vmajor-mode
  414. Symbol for current buffer's major mode.Vmode-name
  415. Pretty name of current buffer's major mode (a string).Vabbrev-mode
  416. Non-nil turns on automatic expansion of abbrevs as they are inserted.
  417. Automatically becomes buffer-local when set in any fashion.Vcase-fold-search
  418. *Non-nil if searches should ignore case.
  419. Automatically becomes buffer-local when set in any fashion.Vfill-column
  420. *Column beyond which automatic line-wrapping should happen.
  421. Automatically becomes buffer-local when set in any fashion.Vleft-margin
  422. *Column for the default indent-line-function to indent to.
  423. Linefeed indents to this column in Fundamental mode.
  424. Automatically becomes buffer-local when set in any fashion.Vtab-width
  425. *Distance between tab stops (for display of tab characters), in columns.
  426. Automatically becomes buffer-local when set in any fashion.Vctl-arrow
  427. *Non-nil means display control chars with uparrow.
  428. Nil means use backslash and octal digits.
  429. An integer means characters >= ctl-arrow are assumed to be printable, and
  430. will be displayed as a single glyph.
  431. Any other value is the same as 160 - the code SPC with the high bit on.
  432.  
  433. The interpretation of this variable is likely to change in the future.
  434.  
  435. Automatically becomes buffer-local when set in any fashion.
  436. This variable does not apply to characters whose display is specified
  437. in the current display table (if there is one).Vtruncate-lines
  438. *Non-nil means do not display continuation lines;
  439. give each line of text one screen line.
  440. Automatically becomes buffer-local when set in any fashion.
  441.  
  442. Note that this is overridden by the variable
  443. `truncate-partial-width-windows' if that variable is non-nil
  444. and this buffer is not full-screen width.Vfile-type
  445. *file-type for file and process input/output.Vdefault-directory
  446. Name of default directory of current buffer.  Should end with slash.
  447. Each buffer has its own value of this variable.Vauto-fill-function
  448. Function called (if non-nil) to perform auto-fill.
  449. It is called after self-inserting a space at a column beyond `fill-column'.
  450. Each buffer has its own value of this variable.
  451. NOTE: This variable is not an ordinary hook;
  452. It may not be a list of functions.Vbuffer-file-name
  453. Name of file visited in current buffer, or nil if not visiting a file.
  454. Each buffer has its own value of this variable.Vbuffer-file-truename
  455. The real name of the file visited in the current buffer, 
  456. or nil if not visiting a file.  This is the result of passing 
  457. buffer-file-name to the real-path-name function.  Every buffer 
  458. has its own value of this variable.  This variable is automatically 
  459. maintained by the functions that change the file name associated 
  460. with a buffer.Vbuffer-auto-save-file-name
  461. Name of file for auto-saving current buffer,
  462. or nil if buffer should not be auto-saved.
  463. Each buffer has its own value of this variable.Vbuffer-read-only
  464. Non-nil if this buffer is read-only.
  465. Each buffer has its own value of this variable.Vbuffer-backed-up
  466. Non-nil if this buffer's file has been backed up.
  467. Backing up is done before the first time the file is saved.
  468. Each buffer has its own value of this variable.Vbuffer-saved-size
  469. Length of current buffer when last read in, saved or auto-saved.
  470. 0 initially.
  471. Each buffer has its own value of this variable.Vselective-display
  472. Non-nil enables selective display:
  473. Integer N as value means display only lines
  474.  that start with less than n columns of space.
  475. A value of t means, after a ^M, all the rest of the line is invisible.
  476.  Then ^M's in the file are written into files as newlines.
  477.  
  478. Automatically becomes buffer-local when set in any fashion.Vlocal-abbrev-table
  479. Local (mode-specific) abbrev table of current buffer.Vselective-display-ellipses
  480. t means display ... on previous line when a line is invisible.
  481. Automatically becomes buffer-local when set in any fashion.Voverwrite-mode
  482. Non-nil if self-insertion should replace existing text.
  483. Automatically becomes buffer-local when set in any fashion.Vbuffer-display-table
  484. Display table that controls display of the contents of current buffer.
  485. Automatically becomes buffer-local when set in any fashion.
  486. The display table is a vector created with `make-display-table'.
  487. The first 256 elements control how to display each possible text character.
  488. The value should be a "rope" (see `make-rope') or nil;
  489. nil means display the character in the default fashion.
  490. The remaining five elements are ropes that control the display of
  491.   the end of a truncated screen line (element 256);
  492.   the end of a continued line (element 257);
  493.   the escape character used to display character codes in octal (element 258);
  494.   the character used as an arrow for control characters (element 259);
  495.   the decoration indicating the presence of invisible lines (element 260).
  496. If this variable is nil, the value of `standard-display-table' is used.
  497. Each window can have its own, overriding display table.Vbuffer-field-list
  498. List of fields in the current buffer.  See `add-field'.Vfind-file-compare-truenames
  499. If this is true, then the find-file command will check the truenames
  500. of all visited files when deciding whether a given file is already in
  501. a buffer, instead of just the buffer-file-name.  This means that if you
  502. attempt to visit another file which is a hard-link or symbolic-link to a
  503. file which is already in a buffer, the existing buffer will be found instead
  504. of a newly-created one.
  505.  
  506. See also the variable find-file-use-truenames.Vfind-file-use-truenames
  507. If this is true, then a buffer's visited file-name will always be
  508. chased back to the real file; it will never be a symbolic link, and there
  509. will never be a symbolic link anywhere in its directory path.
  510. That is, the buffer-file-name and buffer-file-truename will be equal.
  511.  
  512. See also the variable find-file-compare-truenames.Vbefore-change-function
  513. Function to call before each text change.
  514. Two arguments are passed to the function: the positions of
  515. the beginning and end of the range of old text to be changed.
  516. For an insertion, the beginning and end are at the same place.
  517. No information is given about the length of the text after the change.
  518. position of the change
  519.  
  520. While executing the `before-change-function', changes to buffers do not
  521. cause calls to any `before-change-function' or `after-change-function'.Vafter-change-function
  522. Function to call after each text change.
  523. Three arguments are passed to the function: the positions of
  524. the beginning and end of the range of changed text,
  525. and the length of the pre-change text replaced by that range.
  526. For an insertion, the pre-change length is zero;
  527. for a deletion, that length is the number of characters deleted,
  528. and the post-change beginning and end are at the same place.
  529.  
  530. While executing the `after-change-function', changes to buffers do not
  531. cause calls to any `before-change-function' or `after-change-function'.Vfirst-change-function
  532. Function to call before changing a buffer which is unmodified.
  533. The function is called, with no arguments, if it is non-nil.Vbuffer-undo-list
  534. List of undo entries in current buffer.Fbyte-code
  535. Function used internally in byte-compiled code.
  536. The first argument is a string of byte code; the second, a vector of constants;
  537. the third, the maximum stack depth used in this function.
  538. If the third argument is incorrect, Emacs may crash.
  539.  
  540. arguments:(bytestr vector maxdepth)
  541. Vbyte-code-meter
  542. A vector of vectors which holds a histogram of byte-code usage.Vbyte-metering-on
  543. Finteractive
  544. Specify a way of parsing arguments for interactive use of a function.
  545. For example, write
  546.   (defun foo (arg) "Doc string" (interactive "p") ...use arg...)
  547. to make ARG be the prefix argument when `foo' is called as a command.
  548. The "call" to `interactive' is actually a declaration rather than a function;
  549.  it tells `call-interactively' how to read arguments
  550.  to pass to the function.
  551. When actually called, `interactive' just returns nil.
  552.  
  553. The argument of `interactive' is usually a string containing a code letter
  554.  followed by a prompt.  (Some code letters do not use I/O to get
  555.  the argument and do not need prompts.)  To prompt for multiple arguments,
  556.  give a code letter, its prompt, a newline, and another code letter, etc.
  557.  Prompts are passed to format, and may use % escapes to print the
  558.  arguments that have already been read.
  559. If the argument is not a string, it is evaluated to get a list of
  560.  arguments to pass to the function.
  561. Just `(interactive)' means pass no args when calling interactively.
  562.  
  563. Code letters available are:
  564. a -- Function name: symbol with a function definition.
  565. b -- Name of existing buffer.
  566. B -- Name of buffer, possibly nonexistent.
  567. c -- Character.
  568. C -- Command name: symbol with interactive function definition.
  569. d -- Value of point as number.  Does not do I/O.
  570. D -- Directory name.
  571. e -- Last mouse event.
  572. f -- Existing file name.
  573. F -- Possibly nonexistent file name.
  574. k -- Key sequence (a vector of events).
  575. m -- Value of mark as number.  Does not do I/O.
  576. n -- Number read using minibuffer.
  577. N -- Prefix arg converted to number, or if none, do like code `n'.
  578. p -- Prefix arg converted to number.  Does not do I/O.
  579. P -- Prefix arg in raw form.  Does not do I/O.
  580. r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.
  581. s -- Any string.
  582. S -- Any symbol.
  583. v -- Variable name: symbol that is user-variable-p.
  584. x -- Lisp expression read but not evaluated.
  585. X -- Lisp expression read and evaluated.
  586. In addition, if the string begins with `*'
  587.  then an error is signaled if the buffer is read-only.
  588.  This happens before reading any arguments.
  589. If the string begins with `@', then the window the mouse is over is selected
  590.  before anything else is done.  You may use both `@' and `*';
  591. they are processed in the order that they appear.
  592.  
  593. arguments:(args)
  594. Fcall-interactively
  595. Call FUNCTION, reading args according to its interactive calling specs.
  596. The function contains a specification of how to do the argument reading.
  597. In the case of user-defined functions, this is specified by placing a call
  598. to the function `interactive' at the top level of the function body.
  599. See `interactive'.
  600.  
  601. If optional second arg RECORD-FLAG is `t' then unconditionally put this
  602. ommand in the command-history.  Otherwise, this is done only if an arg is
  603. read using the minibuffer.
  604.  
  605. arguments:(function &optional record_flag)
  606. Fprefix-numeric-value
  607. Return numeric meaning of raw prefix argument ARG.
  608. A raw prefix argument is what you get from `(interactive "P")'.
  609. Its numeric meaning is what you would get from `(interactive "p")'.
  610.  
  611. arguments:(raw)
  612. Vprefix-arg
  613. The value of the prefix argument for the next editing command.
  614. It may be a number, or the symbol `-' for just a minus sign as arg,
  615. or a list whose car is a number for just one or more C-U's
  616. or nil if no argument has been specified.
  617.  
  618. You cannot examine this variable to find the argument for this command
  619. since it has been set to nil by the time you can look.
  620. Instead, you should use the variable `current-prefix-arg', although
  621. normally commands can get this prefix argument with (interactive "P").Vcurrent-prefix-arg
  622. The value of the prefix argument for this editing command.
  623. It may be a number, or the symbol `-' for just a minus sign as arg,
  624. or a list whose car is a number for just one or more C-U's
  625. or nil if no argument has been specified.
  626. This is what `(interactive "P")' returns.Vcurrent-mouse-event
  627. The mouse-button event which invoked this command, or nil.
  628. This is what `(interactive "e")' returns.Vcommand-history
  629. List of recent commands that read arguments from terminal.
  630. Each command is represented as a form to evaluate.Vcommand-debug-status
  631. Debugging status of current interactive command.
  632. Bound each time `call-interactively' is called;
  633. may be set by the debugger as a reminder for itself.Fcall-process
  634. Call PROGRAM synchronously in separate process.
  635. The program's input comes from file INFILE (nil means `/dev/null').
  636. Insert output in BUFFER before point; t means current buffer;
  637.  nil for BUFFER means discard it; 0 means discard and don't wait.
  638. Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
  639. Remaining arguments are strings passed as command arguments to PROGRAM.
  640. If BUFFER is nil or 0, returns immediately with value nil.
  641. Otherwise waits for PROGRAM to terminate
  642. and returns a numeric exit status or a signal name as a string.
  643. If you quit, the process is killed with SIGKILL.
  644.  
  645. arguments: (arg1 &rest args)
  646. Fcall-process-region
  647. Send text from START to END to a synchronous process running PROGRAM.
  648. Delete the text if fourth arg DELETE is non-nil.
  649. Insert output in BUFFER before point; t means current buffer;
  650.  nil for BUFFER means discard it; 0 means discard and don't wait.
  651. Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
  652. Remaining args are passed to PROGRAM at startup as command args.
  653. If BUFFER is nil, returns immediately with value nil.
  654. Otherwise waits for PROGRAM to terminate
  655. and returns a numeric exit status or a signal name as a string.
  656. If you quit, the process is killed with SIGKILL.
  657.  
  658. arguments: (arg1 arg2 arg3 &rest args)
  659. Vshell-file-name
  660. *File name to load inferior shells from.
  661. Initialized from the SHELL environment variable.Vexec-path
  662. *List of directories to search programs to run in subprocesses.
  663. Each element is a string (directory name) or nil (try default directory).Vexec-directory
  664. Directory that holds programs that come with GNU Emacs,
  665. intended for Emacs to invoke.Vprocess-environment
  666. List of strings to append to environment of subprocesses that are started.
  667. Each string should have the format ENVVARNAME=VALUE.Fupcase
  668. Convert argument to upper case and return that.
  669. The argument may be a character or string.  The result has the same type.
  670. The argument object is not altered.  See also `capitalize'.
  671.  
  672. arguments:(obj)
  673. Fdowncase
  674. Convert argument to lower case and return that.
  675. The argument may be a character or string.  The result has the same type.
  676. The argument object is not altered.
  677.  
  678. arguments:(obj)
  679. Fcapitalize
  680. Convert argument to capitalized form and return that.
  681. This means that each word's first character is upper case
  682. and the rest is lower case.
  683. The argument may be a character or string.  The result has the same type.
  684. The argument object is not altered.
  685.  
  686. arguments:(obj)
  687. Fupcase-region
  688. Convert the region to upper case.  In programs, wants two arguments.
  689. These arguments specify the starting and ending character numbers of
  690. the region to operate on.  When used as a command, the text between
  691. point and the mark is operated on.
  692. See also `capitalize-region'.
  693.  
  694. arguments:(b e)
  695. Fdowncase-region
  696. Convert the region to lower case.  In programs, wants two arguments.
  697. These arguments specify the starting and ending character numbers of
  698. the region to operate on.  When used as a command, the text between
  699. point and the mark is operated on.
  700.  
  701. arguments:(b e)
  702. Fcapitalize-region
  703. Convert the region to capitalized form.
  704. Capitalized form means each word's first character is upper case
  705. and the rest of it is lower case.
  706. In programs, give two arguments, the starting and ending
  707. character positions to operate on.
  708.  
  709. arguments:(b e)
  710. Fupcase-word
  711. Convert following word (or ARG words) to upper case, moving over.
  712. With negative argument, convert previous words but do not move.
  713. See also `capitalize-word'.
  714.  
  715. arguments:(arg)
  716. Fdowncase-word
  717. Convert following word (or ARG words) to lower case, moving over.
  718. With negative argument, convert previous words but do not move.
  719.  
  720. arguments:(arg)
  721. Fcapitalize-word
  722. Capitalize the following word (or ARG words), moving over.
  723. This gives the word(s) a first character in upper case
  724. and the rest lower case.
  725. With negative argument, capitalize previous words but do not move.
  726.  
  727. arguments:(arg)
  728. Fcase-table-p
  729. Return t iff ARG is a case table.
  730. See `set-case-table' for more information on these data structures.
  731.  
  732. arguments:(table)
  733. Fcurrent-case-table
  734. Return the case table of the current buffer.
  735.  
  736. arguments:()
  737. Fstandard-case-table
  738. Return the standard case table.
  739. This is the one used for new buffers.
  740.  
  741. arguments:()
  742. Fset-case-table
  743. Select a new case table for the current buffer.
  744. A case table is a list (DOWNCASE UPCASE CANONICALIZE EQUIVALENCES)
  745.  where each element is either nil or a string of length 256.
  746. DOWNCASE maps each character to its lower-case equivalent.
  747. UPCASE maps each character to its upper-case equivalent;
  748.  if lower and upper case characters are in 1-1 correspondence,
  749.  you may use nil and the upcase table will be deduced from DOWNCASE.
  750. CANONICALIZE maps each character to a canonical equivalent;
  751.  any two characters that are related by case-conversion have the same
  752.  canonical equivalent character.
  753. EQUIVALENCES is a map that cyclicly permutes each equivalence class
  754.  (of characters with the same canonical equivalent).
  755. Both CANONICALIZE and EQUIVALENCES may be nil, in which case
  756.  both are deduced from DOWNCASE and UPCASE.
  757.  
  758. arguments:(table)
  759. Fset-standard-case-table
  760. Select a new standard case table for new buffers.
  761. See `set-case-table' for more info on case tables.
  762.  
  763. arguments:(table)
  764. Vascii-downcase-table
  765. String mapping ASCII characters to lowercase equivalents.Vascii-upcase-table
  766. String mapping ASCII characters to uppercase equivalents.Fforward-char
  767. Move point right ARG characters (left if ARG negative).
  768. On reaching end of buffer, stop and signal error.
  769.  
  770. arguments:(&optional n)
  771. Fbackward-char
  772. Move point left ARG characters (right if ARG negative).
  773. On attempt to pass beginning or end of buffer, stop and signal error.
  774.  
  775. arguments:(&optional n)
  776. Fforward-line
  777. Move ARG lines forward (backward if ARG is negative).
  778. Precisely, if point is on line I, move to the start of line I + ARG.
  779. If there isn't room, go as far as possible (no error).
  780. Returns the count of lines left to move.  If moving forward,
  781. that is ARG - number of lines moved; if backward, ARG + number moved.
  782. With positive ARG, a non-empty line at the end counts as one line
  783.   successfully moved (for the return value).
  784.  
  785. arguments:(&optional n)
  786. Fbeginning-of-line
  787. Move point to beginning of current line.
  788. With argument ARG not nil or 1, move forward ARG - 1 lines first.
  789. If scan reaches end of buffer, stop there without error.
  790.  
  791. arguments:(&optional n)
  792. Fend-of-line
  793. Move point to end of current line.
  794. With argument ARG not nil or 1, move forward ARG - 1 lines first.
  795. If scan reaches end of buffer, stop there without error.
  796.  
  797. arguments:(&optional n)
  798. Fdelete-char
  799. Delete the following ARG characters (previous, with negative arg).
  800. Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
  801. Interactively, ARG is the prefix arg, and KILLFLAG is set if
  802. ARG was explicitly specified.
  803.  
  804. arguments:(n &optional killflag)
  805. Fdelete-backward-char
  806. Delete the previous ARG characters (following, with negative ARG).
  807. Optional second arg KILLFLAG non-nil means kill instead (save in kill ring).
  808. Interactively, ARG is the prefix arg, and KILLFLAG is set if
  809. ARG was explicitly specified.
  810.  
  811. arguments:(n &optional killflag)
  812. Fself-insert-command
  813. Insert the character you type.
  814. Whichever character you type to run this command is inserted.
  815.  
  816. arguments:(arg)
  817. Fnewline
  818. Insert a newline.  With arg, insert that many newlines.
  819. In Auto Fill mode, if no numeric arg, break the preceding line if it's long.
  820.  
  821. arguments:(&optional arg1)
  822. Vblink-paren-function
  823. Function called, if non-nil, whenever a close parenthesis is inserted.
  824. More precisely, a char with closeparen syntax is self-inserted.Feq
  825. T if the two args are the same Lisp object.
  826.  
  827. arguments:(obj1 obj2)
  828. Fnull
  829. T if OBJECT is nil.
  830.  
  831. arguments:(obj)
  832. Fconsp
  833. T if OBJECT is a cons cell.
  834.  
  835. arguments:(obj)
  836. Fatom
  837. T if OBJECT is not a cons cell.  This includes nil.
  838.  
  839. arguments:(obj)
  840. Flistp
  841. T if OBJECT is a list.  This includes nil.
  842.  
  843. arguments:(obj)
  844. Fnlistp
  845. T if OBJECT is not a list.  Lists include nil.
  846.  
  847. arguments:(obj)
  848. Fsymbolp
  849. T if OBJECT is a symbol.
  850.  
  851. arguments:(obj)
  852. Fvectorp
  853. T if OBJECT is a vector.
  854.  
  855. arguments:(obj)
  856. Fstringp
  857. T if OBJECT is a string.
  858.  
  859. arguments:(obj)
  860. Farrayp
  861. T if OBJECT is an array (string or vector).
  862.  
  863. arguments:(obj)
  864. Fsequencep
  865. T if OBJECT is a sequence (list or array).
  866.  
  867. arguments:(obj)
  868. Fbufferp
  869. T if OBJECT is an editor buffer.
  870.  
  871. arguments:(obj)
  872. Fmarkerp
  873. T if OBJECT is a marker (editor pointer).
  874.  
  875. arguments:(obj)
  876. Finteger-or-marker-p
  877. T if OBJECT is an integer or a marker (editor pointer).
  878.  
  879. arguments:(obj)
  880. Fsubrp
  881. T if OBJECT is a built-in function.
  882.  
  883. arguments:(obj)
  884. Fcompiled-function-p
  885. T if OBJECT is a compiled function object (as returned by make-byte-code.)
  886.  
  887. arguments:(obj)
  888. Fchar-or-string-p
  889. T if OBJECT is a character (a number) or a string.
  890.  
  891. arguments:(obj)
  892. Fintegerp
  893. T if OBJECT is a number.
  894.  
  895. arguments:(obj)
  896. Fnatnump
  897. T if OBJECT is a nonnegative number.
  898.  
  899. arguments:(obj)
  900. Ffloatp
  901. T if OBJECT is a floating point number.
  902.  
  903. arguments:(obj)
  904. Fnumberp
  905. T if OBJECT is a number (floating point or integer).
  906.  
  907. arguments:(obj)
  908. Fnumber-or-marker-p
  909. T if OBJECT is a number or a marker.
  910.  
  911. arguments:(obj)
  912. Fextentp
  913. T if OBJECT is an extent..
  914.  
  915. arguments:(extent)
  916. Fcar
  917. Return the car of CONSCELL.  If arg is nil, return nil.
  918. Error if arg is not nil and not a cons cell.  See also `car-safe'.
  919.  
  920. arguments:(list)
  921. Fcar-safe
  922. Return the car of OBJECT if it is a cons cell, or else nil.
  923.  
  924. arguments:(object)
  925. Fcdr
  926. Return the cdr of CONSCELL.  If arg is nil, return nil.
  927. Error if arg is not nil and not a cons cell.  See also `cdr-safe'.
  928.  
  929. arguments:(list)
  930. Fcdr-safe
  931. Return the cdr of OBJECT if it is a cons cell, or else  nil.
  932.  
  933. arguments:(object)
  934. Fsetcar
  935. Set the car of CONSCELL to be NEWCAR.  Returns NEWCAR.
  936.  
  937. arguments:(cell newcar)
  938. Fsetcdr
  939. Set the cdr of CONSCELL to be NEWCDR.  Returns NEWCDR.
  940.  
  941. arguments:(cell newcdr)
  942. Fboundp
  943. T if SYMBOL's value is not void.
  944.  
  945. arguments:(sym)
  946. Ffboundp
  947. T if SYMBOL's function definition is not void.
  948.  
  949. arguments:(sym)
  950. Fmakunbound
  951. Make SYMBOL's value be void.
  952.  
  953. arguments:(sym)
  954. Ffmakunbound
  955. Make SYMBOL's function definition be void.
  956.  
  957. arguments:(sym)
  958. Fsymbol-function
  959. Return SYMBOL's function definition.  Error if that is void.
  960.  
  961. arguments:(sym)
  962. Fsymbol-plist
  963. Return SYMBOL's property list.
  964.  
  965. arguments:(sym)
  966. Fsymbol-name
  967. Return SYMBOL's name, a string.
  968.  
  969. arguments:(sym)
  970. Ffset
  971. Set SYMBOL's function definition to NEWVAL, and return NEWVAL.
  972.  
  973. arguments:(sym newdef)
  974. Fsetplist
  975. Set SYMBOL's property list to NEWVAL, and return NEWVAL.
  976.  
  977. arguments:(sym newplist)
  978. Fsymbol-value
  979. Return SYMBOL's value.  Error if that is void.
  980.  
  981. arguments:(sym)
  982. Fset
  983. Set SYMBOL's value to NEWVAL, and return NEWVAL.
  984.  
  985. arguments:(sym newval)
  986. Fdefault-boundp
  987. Return T if SYMBOL has a non-void default value.
  988. This is the value that is seen in buffers that do not have their own values
  989. for this variable.
  990.  
  991. arguments:(sym)
  992. Fdefault-value
  993. Return SYMBOL's default value.
  994. This is the value that is seen in buffers that do not have their own values
  995. for this variable.  The default value is meaningful for variables with
  996. local bindings in certain buffers.
  997.  
  998. arguments:(sym)
  999. Fset-default
  1000. Set SYMBOL's default value to VAL.  SYMBOL and VAL are evaluated.
  1001. The default value is seen in buffers that do not have their own values
  1002. for this variable.
  1003.  
  1004. arguments:(sym value)
  1005. Fsetq-default
  1006. Set SYMBOL's default value to VAL.  VAL is evaluated; SYMBOL is not.
  1007. The default value is seen in buffers that do not have their own values
  1008. for this variable.
  1009.  
  1010. arguments: (arg1 arg2 &rest args)
  1011. Fmake-variable-buffer-local
  1012. Make VARIABLE have a separate value for each buffer.
  1013. At any time, the value for the current buffer is in effect.
  1014. There is also a default value which is seen in any buffer which has not yet
  1015. set its own value.
  1016. Using `set' or `setq' to set the variable causes it to have a separate value
  1017. for the current buffer if it was previously using the default value.
  1018. The function `default-value' gets the default value and `set-default' sets it.
  1019.  
  1020. arguments:(sym)
  1021. Fmake-local-variable
  1022. Make VARIABLE have a separate value in the current buffer.
  1023. Other buffers will continue to share a common default value.
  1024. See also `make-variable-buffer-local'.
  1025.  
  1026. arguments:(sym)
  1027. Fkill-local-variable
  1028. Make VARIABLE no longer have a separate value in the current buffer.
  1029. From now on the default value will apply in this buffer.
  1030.  
  1031. arguments:(sym)
  1032. Findirect-function
  1033. Return the function at the end of OBJECT's function chain.
  1034. If OBJECT is a symbol, follow all function indirections and return
  1035. the final function binding.
  1036. If OBJECT is not a symbol, just return it.
  1037. Signal a void-function error if the final symbol is unbound.
  1038. Signal a cyclic-function-indirection error if there is a loop in the
  1039. function chain of symbols.
  1040.  
  1041. arguments:(object)
  1042. Faref
  1043. Return the element of ARRAY at index INDEX.
  1044. ARRAY may be a vector or a string, or a byte-code object.  INDEX starts at 0.
  1045.  
  1046. arguments:(array idx)
  1047. Faset
  1048. Store into the element of ARRAY at index INDEX the value NEWVAL.
  1049. ARRAY may be a vector or a string.  INDEX starts at 0.
  1050.  
  1051. arguments:(array idx newelt)
  1052. F=
  1053. T if two args, both numbers or markers, are equal.
  1054.  
  1055. arguments:(num1 num2)
  1056. F<
  1057. T if first arg is less than second arg.  Both must be numbers or markers.
  1058.  
  1059. arguments:(num1 num2)
  1060. F>
  1061. T if first arg is greater than second arg.  Both must be numbers or markers.
  1062.  
  1063. arguments:(num1 num2)
  1064. F<=
  1065. T if first arg is less than or equal to second arg.
  1066. Both must be numbers or markers.
  1067.  
  1068. arguments:(num1 num2)
  1069. F>=
  1070. T if first arg is greater than or equal to second arg.
  1071. Both must be numbers or markers.
  1072.  
  1073. arguments:(num1 num2)
  1074. F/=
  1075. T if first arg is not equal to second arg.  Both must be numbers or markers.
  1076.  
  1077. arguments:(num1 num2)
  1078. Fzerop
  1079. T if NUMBER is zero.
  1080.  
  1081. arguments:(num)
  1082. Fint-to-string
  1083. Convert INT to a string by printing it in decimal.
  1084. Uses a minus sign if negative.
  1085.  
  1086. arguments:(num)
  1087. Fstring-to-int
  1088. Convert STRING to an integer by parsing it as a decimal number.
  1089.  
  1090. arguments:(str)
  1091. F+
  1092. Return sum of any number of arguments, which are numbers or markers.
  1093.  
  1094. arguments: (&rest args)
  1095. F-
  1096. Negate number or subtract numbers or markers.
  1097. With one arg, negates it.  With more than one arg,
  1098. subtracts all but the first from the first.
  1099.  
  1100. arguments: (&rest args)
  1101. F*
  1102. Returns product of any number of arguments, which are numbers or markers.
  1103.  
  1104. arguments: (&rest args)
  1105. F/
  1106. Returns first argument divided by all the remaining arguments.
  1107. The arguments must be numbers or markers.
  1108.  
  1109. arguments: (arg1 arg2 &rest args)
  1110. F%
  1111. Returns remainder of first arg divided by second.
  1112. Both must be numbers or markers.
  1113.  
  1114. arguments:(num1 num2)
  1115. Fmax
  1116. Return largest of all the arguments (which must be numbers or markers).
  1117. The value is always a number; markers are converted to numbers.
  1118.  
  1119. arguments: (arg1 &rest args)
  1120. Fmin
  1121. Return smallest of all the arguments (which must be numbers or markers).
  1122. The value is always a number; markers are converted to numbers.
  1123.  
  1124. arguments: (arg1 &rest args)
  1125. Flogand
  1126. Return bitwise-and of all the arguments.
  1127. Arguments may be integers, or markers converted to integers.
  1128.  
  1129. arguments: (&rest args)
  1130. Flogior
  1131. Return bitwise-or of all the arguments.
  1132. Arguments may be integers, or markers converted to integers.
  1133.  
  1134. arguments: (&rest args)
  1135. Flogxor
  1136. Return bitwise-exclusive-or of all the arguments.
  1137. Arguments may be integers, or markers converted to integers.
  1138.  
  1139. arguments: (&rest args)
  1140. Fash
  1141. Return VALUE with its bits shifted left by COUNT.
  1142. If COUNT is negative, shifting is actually to the right.
  1143. In this case, the sign bit is duplicated.
  1144.  
  1145. arguments:(num1 num2)
  1146. Flsh
  1147. Return VALUE with its bits shifted left by COUNT.
  1148. If COUNT is negative, shifting is actually to the right.
  1149. In this case,  zeros are shifted in on the left.
  1150.  
  1151. arguments:(num1 num2)
  1152. F1+
  1153. Return NUMBER plus one.  NUMBER may be a number or a marker.
  1154. Markers are converted to integers.
  1155.  
  1156. arguments:(num)
  1157. F1-
  1158. Return NUMBER minus one.  NUMBER may be a number or a marker.
  1159. Markers are converted to integers.
  1160.  
  1161. arguments:(num)
  1162. Flognot
  1163. Return the bitwise complement of ARG.  ARG must be an integer.
  1164.  
  1165. arguments:(num)
  1166. Fdirectory-files
  1167. Return a list of names of files in DIRECTORY.
  1168. There are four optional arguments:
  1169. If FULL is non-nil, absolute pathnames of the files are returned.
  1170. If MATCH is non-nil, only pathnames containing that regexp are returned.
  1171. If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
  1172.  NOSORT is useful if you plan to sort the result yourself.
  1173. If FILES-ONLY is the symbol t, then only the "files" in the directory
  1174.  will be returned; subdirectories will be excluded.  If FILES-ONLY is not
  1175.  nil and not t, then only the subdirectories will be returned.  Otherwise,
  1176.  if FILES-ONLY is nil (the default) then both files and subdirectories will
  1177.  be returned.
  1178.  
  1179. arguments:(dirname &optional full match nosort files_only)
  1180. Ffile-name-completion
  1181. Complete file name FILE in directory DIR.
  1182. Returns the longest string
  1183. common to all filenames in DIR that start with FILE.
  1184. If there is only one and FILE matches it exactly, returns t.
  1185. Returns nil if DIR contains no name starting with FILE.
  1186.  
  1187. arguments:(file dirname)
  1188. Ffile-name-all-completions
  1189. Return a list of all completions of file name FILE in directory DIR.
  1190. These are all file names in directory DIR which begin with FILE.
  1191.  
  1192. arguments:(file dirname)
  1193. Ffile-name-all-versions
  1194. Return a list of all versions of file name FILE in directory DIR.
  1195.  
  1196. arguments:(file dirname)
  1197. Ffile-attributes
  1198. Return a list of attributes of file FILENAME.
  1199. Value is nil if specified file cannot be opened.
  1200. Otherwise, list elements are:
  1201.  0. t for directory, string (name linked to) for symbolic link, or nil.
  1202.  1. Number of links to file.
  1203.  2. File uid.
  1204.  3. File gid.
  1205.  4. Last access time, as a list of two integers.
  1206.   First integer has high-order 16 bits of time, second has low 16 bits.
  1207.  5. Last modification time, likewise.
  1208.  6. Last status change time, likewise.
  1209.  7. Size in bytes.
  1210.  8. File modes, as a string of ten letters or dashes as in ls -l.
  1211.  9. t iff file's gid would change if file were deleted and recreated.
  1212. 10. inode number.
  1213.  
  1214. If file does not exists, returns nil.
  1215.  
  1216. arguments:(filename)
  1217. Ftime-to-string
  1218.  
  1219.  
  1220. arguments:(time)
  1221. Vcompletion-ignored-extensions
  1222. *Completion ignores filenames ending in any string in this list.
  1223. This variable does not affect lists of possible completions,
  1224. but does affect the commands that actually do completions.Fopen-termscript
  1225. Start writing all terminal output to FILE as well as the terminal.
  1226. FILE = nil means just close any termscript file currently open.
  1227.  
  1228. arguments:(file)
  1229. Fsend-string-to-terminal
  1230. Send STRING to the terminal without alteration.
  1231. Control characters in STRING will have terminal-dependent effects.
  1232.  
  1233. arguments:(str)
  1234. Fding
  1235. Beep, or flash the screen.
  1236. Also, unless an argument is given,
  1237. terminate any keyboard macro currently executing.
  1238. When called from lisp, the second argument is what sound to make.
  1239.  
  1240. arguments:(&optional arg sound)
  1241. Finitialize-first-screen
  1242. Make redisplay work on the first screen (do this early.)
  1243.  
  1244. arguments:()
  1245. Vbaud-rate
  1246. The output baud rate of the terminal.
  1247. On most systems, changing this value will affect the amount of padding
  1248. and the other strategic decisions made during redisplay.Vinverse-video
  1249. *Non-nil means invert the entire screen display.
  1250. This means everything is in inverse video which otherwise would not be.Vvisible-bell
  1251. *Non-nil means try to flash the screen to represent a bell.Vno-redraw-on-reenter
  1252. *Non-nil means no need to redraw entire screen after suspending.
  1253. A non-nil value is useful if the terminal can automatically preserve
  1254. Emacs's screen display when you reenter Emacs.
  1255. It is up to you to set this variable if your terminal can do that.Vwindow-system
  1256. A symbol naming the window-system under which Emacs is running,
  1257. such as `x', or nil if emacs is running on an ordinary terminal.Vwindow-system-version
  1258. The version number of the window system in use.
  1259. For X windows, this is 10 or 11.Vcursor-in-echo-area
  1260. Non-nil means put cursor in minibuffer, at end of any message there.Vglyph-table
  1261. Table defining how to output a glyph code to the screen.
  1262. If not nil, this is a vector indexed by glyph code to define the glyph.
  1263. Each element can be:
  1264.  integer: a glyph code which this glyph is an alias for.
  1265.  string: output this glyph using that string (not impl. in X windows).
  1266.  nil: this glyph mod 256 is char code to output,
  1267.     and this glyph / 256 is face code for X windows (see `x-set-face').Vstandard-display-table
  1268. Display table to use for buffers that specify none.
  1269. See `buffer-display-table' for more information.Fdocumentation
  1270. Return the documentation string of FUNCTION.
  1271.  
  1272. arguments:(fun1)
  1273. Fdocumentation-property
  1274. Return the documentation string that is SYMBOL's PROP property.
  1275. This differs from using `get' only in that it can refer to strings
  1276. stored in the `etc/DOC' file.
  1277.  
  1278. arguments:(sym prop)
  1279. FSnarf-documentation
  1280. Used during Emacs initialization, before dumping runnable Emacs,
  1281. to find pointers to doc strings stored in `etc/DOC...' and
  1282. record them in function definitions.
  1283. One arg, FILENAME, a string which does not include a directory.
  1284. The file is found in `../etc' now; found in the `exec-directory'
  1285. when doc strings are referred to later in the dumped Emacs.
  1286.  
  1287. arguments:(filename)
  1288. FVerify-documentation
  1289. Used to make sure everything went well with Snarf-documentation.
  1290. Writes to stderr if not.
  1291.  
  1292. arguments:()
  1293. Fsubstitute-command-keys
  1294. Substitute key descriptions for command names in STRING.
  1295. Return a new string which is STRING with substrings of the form \=\[COMMAND]
  1296. replaced by either:  a keystroke sequence that will invoke COMMAND,
  1297. or "M-x COMMAND" if COMMAND is not on any keys.
  1298. Substrings of the form \=\{MAPVAR} are replaced by summaries
  1299. (made by describe-bindings) of the value of MAPVAR, taken as a keymap.
  1300. Substrings of the form \=\<MAPVAR> specify to use the value of MAPVAR
  1301. as the keymap for future \=\[COMMAND] substrings.
  1302. \=\= quotes the following character and is discarded;
  1303. thus, \=\=\=\= puts \=\= into the output, and \=\=\=\[ puts \=\[ into the output.
  1304.  
  1305. arguments:(str)
  1306. Vinternal-doc-file-name
  1307. Name of file containing documentation strings of built-in symbols.Fint86
  1308.  
  1309.  
  1310. arguments:(intno regs)
  1311. Ffep-init
  1312.  
  1313.  
  1314. arguments:()
  1315. Ffep-term
  1316.  
  1317.  
  1318. arguments:()
  1319. Ffep-on
  1320.  
  1321.  
  1322. arguments:()
  1323. Ffep-off
  1324.  
  1325.  
  1326. arguments:()
  1327. Ffep-force-on
  1328.  
  1329.  
  1330. arguments:()
  1331. Ffep-force-off
  1332.  
  1333.  
  1334. arguments:()
  1335. Fpc98-assign-special-key
  1336.  
  1337.  
  1338. arguments:()
  1339. Fpc98-cancel-special-key
  1340.  
  1341.  
  1342. arguments:()
  1343. Vdos-machine-type
  1344. A symbol naming the dos-machine-type under which Emacs is running,
  1345. (such as `ibmpc'), or nil means running on dos generic mode.Vdos-inhibit-setdisk
  1346. *Non-nil means that changing current drive is inhibited.Vinhibit-fep-control
  1347. *Non-nil means that Kana-Kanji FEP control is inhibited.Fchar-to-string
  1348. Convert arg CHAR to a one-character string containing that character.
  1349.  
  1350. arguments:(n)
  1351. Fstring-to-char
  1352. Convert arg STRING to a character, the first character of that string.
  1353.  
  1354. arguments:(str)
  1355. Fpoint
  1356. Return value of point, as an integer.
  1357. Beginning of buffer is position (point-min)
  1358.  
  1359. arguments:()
  1360. Fpoint-marker
  1361. Return value of point, as a marker object.
  1362. This marker is a copy; you may modify it with reckless abandon.
  1363. If the argument to this function is non-nil, then it returns the real
  1364. point-marker; modifying the position of this marker willl move point.
  1365. It is illegal to change the buffer of it, or make it point nowhere.
  1366.  
  1367. arguments:(&optional dont_copy_p)
  1368. Fgoto-char
  1369. Set point to POSITION, a number or marker.
  1370. Beginning of buffer is position (point-min), end is (point-max).
  1371.  
  1372. arguments:(n)
  1373. Fregion-beginning
  1374. Return position of beginning of region, as an integer.
  1375.  
  1376. arguments:()
  1377. Fregion-end
  1378. Return position of end of region, as an integer.
  1379.  
  1380. arguments:()
  1381. Fzmacs-activate-region
  1382. Make the region between `point' and `mark' be in the active (hilighted)
  1383. state, if `zmacs-regions' is true.  Only a very small number of commands
  1384. should ever do this.
  1385.  
  1386. arguments:()
  1387. Fzmacs-deactivate-region
  1388. Make the region between `point' and `mark' no longer be in the active
  1389. (hilighted) state, if `zmacs-regions' is true.  You shouldn't need to call
  1390. this; the command loop calls it when appropriate.
  1391. Returns t if the region had been active, nil otherwise.
  1392.  
  1393. arguments:()
  1394. Fmark-marker
  1395. Return this buffer's mark, as a marker object.
  1396. If `zmacs-regions' is true, then this returns nil unless the region is
  1397. currently in the active (hilighted) state.  With an argument of t, this
  1398. returns the mark (if there is one) regardless of the zmacs-region state.
  1399. You should *generally* not use the mark unless the region is active, if
  1400. the user has expressed a preference for the zmacs-region model.
  1401. Watch out!  Moving this marker changes the mark position.
  1402. If you set the marker not to point anywhere, the buffer will have no mark.
  1403.  
  1404. arguments:(&optional inactive_p)
  1405. Fsave-excursion
  1406. Save point (and mark), execute BODY, then restore point and mark.
  1407. Executes BODY just like `progn'.  Point and mark values are restored
  1408. even in case of abnormal exit (throw or error).
  1409.  
  1410. arguments: (&rest args)
  1411. Fbuffer-size
  1412. Return the number of characters in the current buffer.
  1413.  
  1414. arguments:()
  1415. Fpoint-min
  1416. Return the minimum permissible value of point in the current buffer.
  1417. This is 1, unless a clipping restriction is in effect.
  1418.  
  1419. arguments:()
  1420. Fpoint-min-marker
  1421. Return a marker to the minimum permissible value of point in this buffer.
  1422. This is the beginning, unless a clipping restriction is in effect.
  1423.  
  1424. arguments:()
  1425. Fpoint-max
  1426. Return the maximum permissible value of point in the current buffer.
  1427. This is (1+ (buffer-size)), unless a clipping restriction is in effect,
  1428. in which case it is less.
  1429.  
  1430. arguments:()
  1431. Fpoint-max-marker
  1432. Return a marker to the maximum permissible value of point in this buffer.
  1433. This is (1+ (buffer-size)), unless a clipping restriction is in effect,
  1434. in which case it is less.
  1435.  
  1436. arguments:()
  1437. Ffollowing-char
  1438. Return the character following point, as a number.
  1439.  
  1440. arguments:()
  1441. Fpreceding-char
  1442. Return the character preceding point, as a number.
  1443.  
  1444. arguments:()
  1445. Fbobp
  1446. Return T if point is at the beginning of the buffer.
  1447. If the buffer is narrowed, this means the beginning of the narrowed part.
  1448.  
  1449. arguments:()
  1450. Feobp
  1451. Return T if point is at the end of the buffer.
  1452. If the buffer is narrowed, this means the end of the narrowed part.
  1453.  
  1454. arguments:()
  1455. Fbolp
  1456. Return T if point is at the beginning of a line.
  1457.  
  1458. arguments:()
  1459. Feolp
  1460. Return T if point is at the end of a line.
  1461. `End of a line' includes point being at the end of the buffer.
  1462.  
  1463. arguments:()
  1464. Fchar-after
  1465. Return character in current buffer at position POS.
  1466. POS is an integer or a buffer pointer.
  1467. If POS is out of range, the value is nil.
  1468.  
  1469. arguments:(pos)
  1470. Fuser-login-name
  1471. Return the name under which the user logged in, as a string.
  1472. This is based on the effective uid, not the real uid.
  1473. Also, if the environment variable USER or LOGNAME is set,
  1474. that determines the value of this function.
  1475.  
  1476. arguments:()
  1477. Fuser-real-login-name
  1478. Return the name of the user's real uid, as a string.
  1479. Differs from `user-login-name' when running under `su'.
  1480.  
  1481. arguments:()
  1482. Fuser-uid
  1483. Return the effective uid of Emacs, as an integer.
  1484.  
  1485. arguments:()
  1486. Fuser-real-uid
  1487. Return the real uid of Emacs, as an integer.
  1488.  
  1489. arguments:()
  1490. Fuser-full-name
  1491. Return the full name of the user logged in, as a string.
  1492.  
  1493. arguments:()
  1494. Fsystem-name
  1495. Return the name of the machine you are running on, as a string.
  1496.  
  1497. arguments:()
  1498. Fcurrent-time-seconds
  1499. Returns the current time as the number of seconds since Jan. 1, 1970, 00:00,
  1500. Greenwich Mean Time.  Since emacs can't represent integers that large, this
  1501. is returned as a cons of two 16-bit numbers.  You can pass this value as an
  1502. argument to current-time-string to get that time as a string.
  1503.  
  1504. arguments:(&optional cons)
  1505. Fcurrent-time-string
  1506. Return the current time, as a human-readable string.
  1507. Programs can use it too, since the number of columns in each field is fixed.
  1508. The format is `Sun Sep 16 01:03:52 1973'.
  1509. If the optional argument is non-nil, it must be a cons of two integers, which
  1510. are the upper and lower 16 bits of a time in seconds (such as the value 
  1511. returned by the current-time-seconds function.
  1512. In a future Emacs version, the time zone may be added at the end,
  1513. if we can figure out a reasonably easy way to get that information.
  1514.  
  1515. arguments:(&optional arg)
  1516. Fset-default-file-mode
  1517. Set Unix `umask' value to ARGUMENT, and return old value.
  1518. The `umask' value is the default protection mode for new files.
  1519.  
  1520. arguments:(nmask)
  1521. Funix-sync
  1522. Tell Unix to finish all pending disk updates.
  1523.  
  1524. arguments:()
  1525. Finsert
  1526. Insert the arguments, either strings or characters, at point.
  1527. Point moves forward so that it ends up after the inserted text.
  1528. Any other markers at the point of insertion remain before the text.
  1529.  
  1530. arguments: (&rest args)
  1531. Finsert-before-markers
  1532. Insert strings or characters at point, relocating markers after the text.
  1533. Point moves forward so that it ends up after the inserted text.
  1534. Any other markers at the point of insertion also end up after the text.
  1535.  
  1536. arguments: (&rest args)
  1537. Finsert-char
  1538. Insert COUNT (second arg) copies of CHAR (first arg).
  1539. Point and all markers are affected as in the function `insert'.
  1540. Both arguments are required.
  1541.  
  1542. arguments:(chr count)
  1543. Fbuffer-substring
  1544. Return the contents of part of the current buffer as a string.
  1545. The two arguments START and END are character positions;
  1546. they can be in either order.
  1547.  
  1548. arguments:(b e)
  1549. Fbuffer-string
  1550. Return the contents of the current buffer as a string.
  1551.  
  1552. arguments:()
  1553. Finsert-buffer-substring
  1554. Insert before point a substring of the contents buffer BUFFER.
  1555. BUFFER may be a buffer or a buffer name.
  1556. Arguments START and END are character numbers specifying the substring.
  1557. They default to the beginning and the end of BUFFER.
  1558.  
  1559. arguments:(buf &optional b e)
  1560. Fsubst-char-in-region
  1561. From START to END, replace FROMCHAR with TOCHAR each time it occurs.
  1562. If optional arg NOUNDO is non-nil, don't record this change for undo
  1563. and don't mark the buffer as really changed.
  1564.  
  1565. arguments:(start end fromchar tochar &optional noundo)
  1566. Ftranslate-region
  1567. From START to END, translate characters according to TABLE.
  1568. TABLE is a string; the Nth character in it is the mapping
  1569. for the character with code N.  Returns the number of characters changed.
  1570.  
  1571. arguments:(start end table)
  1572. Fdelete-region
  1573. Delete the text between point and mark.
  1574. When called from a program, expects two arguments,
  1575. positions (integers or markers) specifying the stretch to be deleted.
  1576.  
  1577. arguments:(b e)
  1578. Fwiden
  1579. Remove restrictions (narrowing) from current buffer.
  1580. This allows the buffer's full text to be seen and edited.
  1581.  
  1582. arguments:()
  1583. Fnarrow-to-region
  1584. Restrict editing in this buffer to the current region.
  1585. The rest of the text becomes temporarily invisible and untouchable
  1586. but is not deleted; if you save the buffer in a file, the invisible
  1587. text is included in the file.  \[widen] makes all visible again.
  1588. See also `save-restriction'.
  1589.  
  1590. When calling from a program, pass two arguments; positions (integers
  1591. or markers) bounding the text that should remain visible.
  1592.  
  1593. arguments:(b e)
  1594. Fsave-restriction
  1595. Execute BODY, saving and restoring current buffer's restrictions.
  1596. The buffer's restrictions make parts of the beginning and end invisible.
  1597. (They are set up with `narrow-to-region' and eliminated with `widen'.)
  1598. This special form, `save-restriction', saves the current buffer's restrictions
  1599. when it is entered, and restores them when it is exited.
  1600. So any `narrow-to-region' within BODY lasts only until the end of the form.
  1601. The old restrictions settings are restored
  1602. even in case of abnormal exit (throw or error).
  1603.  
  1604. The value returned is the value of the last form in BODY.
  1605.  
  1606. `save-restriction' can get confused if, within the BODY, you widen
  1607. and then make changes outside the area within the saved restrictions.
  1608.  
  1609. Note: if you are using both `save-excursion' and `save-restriction',
  1610. use `save-excursion' outermost:
  1611.     (save-excursion (save-restriction ...))
  1612.  
  1613. arguments: (&rest args)
  1614. Fmessage
  1615. Print a one-line message at the bottom of the screen.
  1616. The first argument is a control string.
  1617. It may contain %s or %d or %c to print successive following arguments.
  1618. %s means print an argument as a string, %d means print as number in decimal,
  1619. %c means print a number as a single character.
  1620. The argument used by %s must be a string or a symbol;
  1621. the argument used by %d or %c must be a number.
  1622.  
  1623. arguments: (arg1 &rest args)
  1624. Fformat
  1625. Format a string out of a control-string and arguments.
  1626. The first argument is a control string.
  1627. The other arguments are substituted into it to make the result, a string.
  1628. It may contain %-sequences meaning to substitute the next argument.
  1629. %s means print strings using princ, and any other objects using prin1.
  1630. %S means print all objects using prin1 (strings too).
  1631. %d means print as number in decimal (%o octal, %x hex).
  1632. %c means print a number as a single character.
  1633. The argument used for %d, %o, %x or %c must be a number.
  1634.  
  1635. arguments: (arg1 &rest args)
  1636. Fchar-equal
  1637. Return t if two characters match, optionally ignoring case.
  1638. Both arguments must be characters (i.e. integers).
  1639. Case is ignored if `case-fold-search' is non-nil in the current buffer.
  1640.  
  1641. arguments:(c1 c2)
  1642. Fgetenv
  1643. Return the value of environment variable VAR, as a string.
  1644. VAR should be a string.  Value is nil if VAR is undefined in the environment.
  1645.  
  1646. arguments:(str ignored)
  1647. Vsystem-name
  1648. The name of the machine Emacs is running on.Vuser-full-name
  1649. The full name of the user logged in.Vuser-name
  1650. The user's name, based on the effective uid.Vuser-real-name
  1651. The user's name, base upon the real uid.Vzmacs-regions
  1652. *Whether LISPM-style active regions should be used.
  1653. This means that commands which operate on the region (the area between the
  1654. point and the mark) will only work while the region is in the ``active''
  1655. state, which is indicated by hilighting.  Executing most commands causes
  1656. the region to not be in the active state, so (for example) \[kill-region] will only
  1657. work immediately after activating the region.
  1658.  
  1659. More specifically:
  1660.  
  1661.  - Commands which operate on the region only work if the region is active.
  1662.  - Only a very small set of commands cause the region to become active:
  1663.    Those commands whose semantics are to mark an area, like mark-defun.
  1664.  - The region is deactivated after each command that is executed, except that:
  1665.  - "Motion" commands do not change whether the region is active or not.
  1666.  
  1667. set-mark-command (C-SPC) pushes a mark and activates the region.  Moving the
  1668. cursor with normal motion commands (C-n, C-p, etc) will cause the region
  1669. between point and the recently-pushed mark to be highlighted.  It will
  1670. remain highlighted until some non-motion comand is executed.
  1671.  
  1672. exchange-point-and-mark (\[exchange-point-and-mark]) activates the region.  So if you mark a
  1673. region and execute a command that operates on it, you can reactivate the
  1674. same region with \[exchange-point-and-mark] (or perhaps \[exchange-point-and-mark] \[exchange-point-and-mark]) to operate on it
  1675. again.
  1676.  
  1677. Generally, commands which push marks as a means of navigation (like
  1678. beginning-of-buffer and end-of-buffer (M-< and M->)) do not activate the
  1679. region.  But commands which push marks as a means of marking an area of
  1680. text (like mark-defun (\[mark-defun]), mark-word (\[mark-word]) or mark-whole-buffer (\[mark-whole-buffer]))
  1681. do activate the region.Vzmacs-activate-region-hook
  1682. Function or functions called when the region becomes active;
  1683. see the variable `zmacs-regions'.Vzmacs-deactivate-region-hook
  1684. Function or functions called when the region becomes inactive;
  1685. see the variable `zmacs-regions'.Vzmacs-update-region-hook
  1686. Function or functions called when the active region changes.
  1687. This is called after each command that sets `region-stays' to t.
  1688. See the variable `zmacs-regions'.Vzmacs-region-stays
  1689. Commands which do not wish to affect whether the region is currently
  1690. hilighted should set this to t.  Normally, the region is turned off after
  1691. executing each command that did not explicitly turn it on with the function
  1692. zmacs-activate-region. Setting this to true lets a command be non-intrusive.
  1693. See the variable `zmacs-regions'.Fhashtablep
  1694. Returns T if OBJ is a hashtable, else NIL.
  1695.  
  1696. arguments:(obj)
  1697. Fmake-hashtable
  1698. Make a hashtable of initial size SIZE.
  1699.  
  1700. arguments:(size)
  1701. Fcopy-hashtable
  1702. Make a new hashtable which contains the same keys and values
  1703. as the given table.  The keys and values will not themselves be copied.
  1704.  
  1705. arguments:(old_table)
  1706. Fgethash
  1707. Find hash value for KEY in TABLE.
  1708. If there is no corresponding value, return DEFAULT (default nil)
  1709.  
  1710. arguments:(key table &optional defalt)
  1711. Fremhash
  1712. Remove hash value for KEY in TABLE.
  1713.  
  1714. arguments:(key table)
  1715. Fputhash
  1716. Hash KEY to VAL in TABLE.
  1717.  
  1718. arguments:(key val table)
  1719. Fclrhash
  1720. Flush TABLE.
  1721.  
  1722. arguments:(table)
  1723. Fhashtable-fullness
  1724. Returns number of entries in TABLE.
  1725.  
  1726. arguments:(table)
  1727. Fmaphash
  1728. Map FUNCTION over entries in TABLE, calling it with two args,
  1729. each key and value in the table.
  1730.  
  1731. arguments:(function table)
  1732. Frun-emacs-from-temacs
  1733. Do not call this.  It will reinitialize your Emacs.  You'll be sorry.
  1734.  
  1735. arguments: (&rest args)
  1736. Fkill-emacs
  1737. Exit the Emacs job and kill it.  Ask for confirmation, without argument.
  1738. If ARG is an integer, return ARG as the exit program code.
  1739. If ARG is a  string, stuff it as keyboard input.
  1740.  
  1741. The value of `kill-emacs-hook', if not void,
  1742. is a list of functions (of no args),
  1743. all of which are called before Emacs is actually killed.
  1744.  
  1745. arguments:(&optional arg)
  1746. Fdump-emacs
  1747. Dump current state of Emacs into executable file FILENAME.
  1748. Take symbols from SYMFILE (presumably the file you executed to run Emacs).
  1749. This is used in the file `loadup.el' when building Emacs.
  1750.  
  1751. Bind `command-line-processed' to nil before dumping,
  1752. if you want the dumped Emacs to process its command line
  1753. and announce itself normally when it is run.
  1754.  
  1755. arguments:(intoname symname)
  1756. Fnoninteractive
  1757. Non-nil return value means Emacs is running without interactive terminal.
  1758.  
  1759. arguments:()
  1760. Vcommand-line-args
  1761. Args passed by shell to Emacs, as a list of strings.Vinvocation-name
  1762. Name of file used to invoke editing session.
  1763. This is the same as `(file-name-nondirectory execution-path)'.Vexecution-path
  1764. Pathname of executable emacs program now running.Vsystem-type
  1765. Value is symbol indicating type of operating system you are using.Vnoninteractive
  1766. Non-nil means Emacs is running without interactive terminal.Fgetenv
  1767. Return the value of environment variable VAR, as a string.
  1768. When invoked interactively, print the value in the echo area.
  1769. VAR is a string, the name of the variable,
  1770.  or the symbol t, meaning to return an alist representing the
  1771.  current environment.
  1772.  
  1773. arguments:(str &optional interactivep)
  1774. Fsetenv
  1775. Set the value of environment variable VAR to VALUE.
  1776. Both args must be strings.  Returns VALUE.
  1777.  
  1778. arguments:(str &optional val)
  1779. For
  1780. Eval args until one of them yields non-nil, then return that value.
  1781. The remaining args are not evalled at all.
  1782. If all args return nil, return nil.
  1783.  
  1784. arguments: (&rest args)
  1785. Fand
  1786. Eval args until one of them yields nil, then return nil.
  1787. The remaining args are not evalled at all.
  1788. If no arg yields nil, return the last arg's value.
  1789.  
  1790. arguments: (&rest args)
  1791. Fif
  1792. (if COND THEN ELSE...): if COND yields non-nil, do THEN, else do ELSE...
  1793. Returns the value of THEN or the value of the last of the ELSE's.
  1794. THEN must be one expression, but ELSE... can be zero or more expressions.
  1795. If COND yields nil, and there are no ELSE's, the value is nil.
  1796.  
  1797. arguments: (arg1 arg2 &rest args)
  1798. Fcond
  1799. (cond CLAUSES...): try each clause until one succeeds.
  1800. Each clause looks like (CONDITION BODY...).  CONDITION is evaluated
  1801. and, if the value is non-nil, this clause succeeds:
  1802. then the expressions in BODY are evaluated and the last one's
  1803. value is the value of the cond-form.
  1804. If no clause succeeds, cond returns nil.
  1805. If a clause has one element, as in (CONDITION),
  1806. CONDITION's value if non-nil is returned from the cond-form.
  1807.  
  1808. arguments: (&rest args)
  1809. Fprogn
  1810. (progn BODY...): eval BODY forms sequentially and return value of last one.
  1811.  
  1812. arguments: (&rest args)
  1813. Fprog1
  1814. (prog1 FIRST BODY...): eval FIRST and BODY sequentially; value from FIRST.
  1815. The value of FIRST is saved during the evaluation of the remaining args,
  1816. whose values are discarded.
  1817.  
  1818. arguments: (arg1 &rest args)
  1819. Fprog2
  1820. (prog1 X Y BODY...): eval X, Y and BODY sequentially; value from Y.
  1821. The value of Y is saved during the evaluation of the remaining args,
  1822. whose values are discarded.
  1823.  
  1824. arguments: (arg1 arg2 &rest args)
  1825. Fsetq
  1826. (setq SYM VAL SYM VAL ...): set each SYM to the value of its VAL.
  1827. The SYMs are not evaluated.  Thus (setq x y) sets x to the value of y.
  1828. Each SYM is set before the next VAL is computed.
  1829.  
  1830. arguments: (&rest args)
  1831. Fquote
  1832. Return the argument, without evaluating it.  `(quote x)' yields `x'.
  1833.  
  1834. arguments: (arg1 &rest args)
  1835. Ffunction
  1836. Like `quote', but preferred for objects which are functions.
  1837. In byte compilation, `function' causes its argument to be compiled.
  1838. `quote' cannot do that.
  1839.  
  1840. arguments: (arg1 &rest args)
  1841. Finteractive-p
  1842. Return t if function in which this appears was called interactively.
  1843. This means that the function was called with call-interactively (which
  1844. includes being called as the binding of a key)
  1845. and input is currently coming from the keyboard (not in keyboard macro).
  1846.  
  1847. arguments:()
  1848. Fdefun
  1849. (defun NAME ARGLIST [DOCSTRING] BODY...): define NAME as a function.
  1850. The definition is (lambda ARGLIST [DOCSTRING] BODY...).
  1851. See also the function `interactive'.
  1852.  
  1853. arguments: (arg1 arg2 &rest args)
  1854. Fdefmacro
  1855. (defmacro NAME ARGLIST [DOCSTRING] BODY...): define NAME as a macro.
  1856. The definition is (macro lambda ARGLIST [DOCSTRING] BODY...).
  1857. When the macro is called, as in (NAME ARGS...),
  1858. the function (lambda ARGLIST BODY...) is applied to
  1859. the list ARGS... as it appears in the expression,
  1860. and the result should be a form to be evaluated instead of the original.
  1861.  
  1862. arguments: (arg1 arg2 &rest args)
  1863. Fdefvar
  1864. (defvar SYMBOL INITVALUE DOCSTRING): define SYMBOL as a variable.
  1865. You are not required to define a variable in order to use it,
  1866. but the definition can supply documentation and an initial value
  1867. in a way that tags can recognize.
  1868.  
  1869. INITVALUE is evaluated, and used to set SYMBOL, only if SYMBOL's value is void.
  1870. If SYMBOL is buffer-local, its default value is what is set;
  1871.  buffer-local values are not affected.
  1872. INITVALUE and DOCSTRING are optional.
  1873. If DOCSTRING starts with *, this variable is identified as a user option.
  1874.  This means that M-x set-variable and M-x edit-options recognize it.
  1875. If INITVALUE is missing, SYMBOL's value is not set.
  1876.  
  1877. arguments: (arg1 &rest args)
  1878. Fdefconst
  1879. (defconst SYMBOL INITVALUE DOCSTRING): define SYMBOL as a constant variable.
  1880. The intent is that programs do not change this value, but users may.
  1881. Always sets the value of SYMBOL to the result of evalling INITVALUE.
  1882. If SYMBOL is buffer-local, its default value is what is set;
  1883.  buffer-local values are not affected.
  1884. DOCSTRING is optional.
  1885. If DOCSTRING starts with *, this variable is identified as a user option.
  1886.  This means that M-x set-variable and M-x edit-options recognize it.
  1887.  
  1888. Note: do not use `defconst' for user options in libraries that are not
  1889. normally loaded, since it is useful for users to be able to specify
  1890. their own values for such variables before loading the library.
  1891. Since `defconst' unconditionally assigns the variable,
  1892. it would override the user's choice.
  1893.  
  1894. arguments: (arg1 arg2 &rest args)
  1895. Fuser-variable-p
  1896. Returns t if VARIABLE is intended to be set and modified by users.
  1897. (The alternative is a variable used internally in a Lisp program.)
  1898. Determined by whether the first character of the documentation
  1899. for the variable is "*"
  1900.  
  1901. arguments:(variable)
  1902. Flet*
  1903. (let* VARLIST BODY...): bind variables according to VARLIST then eval BODY.
  1904. The value of the last form in BODY is returned.
  1905. Each element of VARLIST is a symbol (which is bound to nil)
  1906. or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
  1907. Each VALUEFORM can refer to the symbols already bound by this VARLIST.
  1908.  
  1909. arguments: (arg1 &rest args)
  1910. Flet
  1911. (let VARLIST BODY...): bind variables according to VARLIST then eval BODY.
  1912. The value of the last form in BODY is returned.
  1913. Each element of VARLIST is a symbol (which is bound to nil)
  1914. or a list (SYMBOL VALUEFORM) (which binds SYMBOL to the value of VALUEFORM).
  1915. All the VALUEFORMs are evalled before any symbols are bound.
  1916.  
  1917. arguments: (arg1 &rest args)
  1918. Fwhile
  1919. (while TEST BODY...): if TEST yields non-nil, eval BODY... and repeat.
  1920. The order of execution is thus TEST, BODY, TEST, BODY and so on
  1921. until TEST returns nil.
  1922.  
  1923. arguments: (arg1 &rest args)
  1924. Fmacroexpand
  1925. Return result of expanding macros at top level of FORM.
  1926. If FORM is not a macro call, it is returned unchanged.
  1927. Otherwise, the macro is expanded and the expansion is considered
  1928. in place of FORM.  When a non-macro-call results, it is returned.
  1929.  
  1930. The second optional arg ENVIRONMENT species an environment of macro
  1931. definitions to shadow the loaded ones for use in file byte-compilation.
  1932.  
  1933. arguments:(form &optional env)
  1934. Fcatch
  1935. (catch TAG BODY...): eval BODY allowing nonlocal exits using `throw'.
  1936. TAG is evalled to get the tag to use.  Then the BODY is executed.
  1937. Within BODY, (throw TAG) with same tag exits BODY and exits this `catch'.
  1938. If no throw happens, `catch' returns the value of the last BODY form.
  1939. If a throw happens, it specifies the value to return from `catch'.
  1940.  
  1941. arguments: (arg1 &rest args)
  1942. Fthrow
  1943. (throw TAG VALUE): throw to the catch for TAG and return VALUE from it.
  1944. Both TAG and VALUE are evalled.
  1945.  
  1946. arguments:(tag val)
  1947. Funwind-protect
  1948. Do BODYFORM, protecting with UNWINDFORMS.
  1949. Usage looks like (unwind-protect BODYFORM UNWINDFORMS...).
  1950. If BODYFORM completes normally, its value is returned
  1951. after executing the UNWINDFORMS.
  1952. If BODYFORM exits nonlocally, the UNWINDFORMS are executed anyway.
  1953.  
  1954. arguments: (arg1 &rest args)
  1955. Fcondition-case
  1956. Regain control when an error is signaled.
  1957. Usage looks like (condition-case VAR BODYFORM HANDLERS...).
  1958. executes BODYFORM and returns its value if no error happens.
  1959. Each element of HANDLERS looks like (CONDITION-NAME BODY...)
  1960. where the BODY is made of Lisp expressions.
  1961.  
  1962. A handler is applicable to an error
  1963. if CONDITION-NAME is one of the error's condition names.
  1964. If an error happens, the first applicable handler is run.
  1965.  
  1966. When a handler handles an error,
  1967. control returns to the condition-case and the handler BODY... is executed
  1968. with VAR bound to (SIGNALED-CONDITIONS . SIGNAL-DATA).
  1969. VAR may be nil; then you do not get access to the signal information.
  1970.  
  1971. The value of the last BODY form is returned from the condition-case.
  1972. See also the function `signal' for more info.
  1973.  
  1974. arguments: (arg1 arg2 &rest args)
  1975. Fsignal
  1976. Signal an error.  Args are SIGNAL-NAME, and associated DATA.
  1977. A signal name is a symbol with an `error-conditions' property
  1978. that is a list of condition names.
  1979. A handler for any of those names will get to handle this signal.
  1980. The symbol `error' should normally be one of them.
  1981.  
  1982. DATA should be a list.  Its elements are printed as part of the error message.
  1983. If the signal is handled, DATA is made available to the handler.
  1984. See also the function `condition-case'.
  1985.  
  1986. arguments:(sig data)
  1987. Fcommandp
  1988. T if FUNCTION makes provisions for interactive calling.
  1989. This means it contains a description for how to read arguments to give it.
  1990. The value is nil for an invalid function or a symbol with no function
  1991. definition.
  1992.  
  1993. Interactively callable functions include strings and vectors (treated
  1994. as keyboard macros), lambda-expressions that contain a top-level call
  1995. to `interactive', autoload definitions made by `autoload' with non-nil
  1996. fourth argument, and some of the built-in functions of Lisp.
  1997.  
  1998. Also, a symbol satisfies `commandp' if its function definition does so.
  1999.  
  2000. arguments:(function)
  2001. Fautoload
  2002. Define FUNCTION to autoload from FILE.
  2003. FUNCTION is a symbol; FILE is a file name string to pass to `load'.
  2004. Third arg DOCSTRING is documentation for the function.
  2005. Fourth arg INTERACTIVE if non-nil says function can be called interactively.
  2006. Fifth arg MACRO if non-nil says the function is really a macro.
  2007. Third through fifth args give info about the real definition.
  2008. They default to nil.
  2009. If FUNCTION is already defined other than as an autoload,
  2010. this does nothing and returns nil.
  2011.  
  2012. arguments:(function file &optional docstring interactive macro)
  2013. Feval
  2014. Evaluate FORM and return its value.
  2015.  
  2016. arguments:(form)
  2017. Fapply
  2018. Call FUNCTION with our remaining args, using our last arg as list of args.
  2019. Thus, (apply '+ 1 2 '(3 4)) returns 10.
  2020.  
  2021. arguments: (arg1 arg2 &rest args)
  2022. Ffuncall
  2023. Call first argument as a function, passing remaining arguments to it.
  2024. Thus,  (funcall 'cons 'x 'y)  returns  (x . y).
  2025.  
  2026. arguments: (arg1 &rest args)
  2027. Fbacktrace-debug
  2028. Set the debug-on-exit flag of eval frame LEVEL levels down to FLAG.
  2029. The debugger is entered when that frame exits, if the flag is non-nil.
  2030.  
  2031. arguments:(level flag)
  2032. Fbacktrace
  2033. Print a trace of Lisp function calls currently active.
  2034. Output stream used is value of `standard-output'.
  2035.  
  2036. arguments:(&optional stream)
  2037. Fbacktrace-frame
  2038. Return the function and arguments N frames up from current execution point.
  2039. If that frame has not evaluated the arguments yet (or is a special form),
  2040. the value is (nil FUNCTION ARG-FORMS...).
  2041. If that frame has evaluated its arguments and called its function already,
  2042. the value is (t FUNCTION ARG-VALUES...).
  2043. A &rest arg is represented as the tail of the list ARG-VALUES.
  2044. FUNCTION is whatever was supplied as car of evaluated list,
  2045. or a lambda expression for macro calls.
  2046. If N is more than the number of frames, the value is nil.
  2047.  
  2048. arguments:(nframes)
  2049. Vmax-specpdl-size
  2050. Limit on number of Lisp variable bindings & unwind-protects before error.Vmax-lisp-eval-depth
  2051. Limit on depth in `eval', `apply' and `funcall' before error.
  2052. This limit is to catch infinite recursions for you before they cause
  2053. actual stack overflow in C, which would be fatal for Emacs.
  2054. You can safely make it considerably larger than its default value,
  2055. if that proves inconveniently small.Vquit-flag
  2056. Non-nil causes `eval' to abort, unless `inhibit-quit' is non-nil.
  2057. Typing C-G sets `quit-flag' non-nil, regardless of `inhibit-quit'.Vinhibit-quit
  2058. Non-nil inhibits C-g quitting from happening immediately.
  2059. Note that `quit-flag' will still be set by typing C-g,
  2060. so a quit will be signalled as soon as `inhibit-quit' is nil.
  2061. To prevent this happening, set `quit-flag' to nil
  2062. before making `inhibit-quit' nil.Vstack-trace-on-error
  2063. *Non-nil means automatically display a backtrace buffer
  2064. after any error that is handled by the editor command loop.
  2065. If the value is a list, an error only means to display a backtrace
  2066. if one of its condition symbols appears in the list.Vdebug-on-error
  2067. *Non-nil means enter debugger if an error is signalled.
  2068. Does not apply to errors handled by `condition-case'.
  2069. If the value is a list, an error only means to enter the debugger
  2070. if one of its condition symbols appears in the list.
  2071. See also variable `debug-on-quit'.Vdebug-on-quit
  2072. *Non-nil means enter debugger if quit is signalled (C-G, for example).
  2073. Does not apply if quit is handled by a `condition-case'.Vdebug-on-next-call
  2074. Non-nil means enter debugger before next `eval', `apply' or `funcall'.Vdebugger
  2075. Function to call to invoke debugger.
  2076. If due to frame exit, args are `exit' and the value being returned;
  2077.  this function's value will be returned instead of that.
  2078. If due to error, args are `error' and a list of the args to `signal'.
  2079. If due to `apply' or `funcall' entry, one arg, `lambda'.
  2080. If due to `eval' entry, one arg, t.Vmocklisp-arguments
  2081. While in a mocklisp function, the list of its unevaluated args.Vrun-hooks
  2082. Set to the function `run-hooks', if that function has been defined.
  2083. Otherwise, nil (in a bare Emacs without preloaded Lisp code).Fallocate-event
  2084. Returns an empty event structure.
  2085. WARNING, the event object returned may be a reused one; see the function
  2086. `deallocate-event'.
  2087.  
  2088. arguments:()
  2089. Fdeallocate-event
  2090. Allow the given event structure to be reused.  You MUST NOT use this 
  2091. event object after calling this function with it.  You will lose.
  2092. It is not necessary to call this function, as event objects are garbage-
  2093. collected like all other objects; however, it may be more efficient to
  2094. explicitly deallocate events when you are sure that that is safe.
  2095.  
  2096. arguments:(event)
  2097. Fcopy-event
  2098. Make a copy of the given event object.  If a second argument is given,
  2099. the first event is copied into the second and the second is returned.
  2100. If the second argument is not supplied (or is nil) then a new event will
  2101. be made as with `allocate-event.'  See also the function `deallocate-event'.
  2102.  
  2103. arguments:(event1 &optional event2)
  2104. Finput-pending-p
  2105. T if command input is currently available with no waiting.
  2106. Actually, the value is nil only if we can be sure that no input is available.
  2107.  
  2108. arguments:()
  2109. Fenqueue-eval-event
  2110. Add an eval event to the back of the queue.
  2111. (enqueue-eval-event <function> <object>)
  2112. It will be the next event read after all pending events.
  2113.  
  2114. arguments:(function object)
  2115. Fnext-event
  2116. Given an event structure, fills it in with the next event available
  2117. from the window system or terminal driver.  Pass this object to
  2118. dispatch-event to handle it.  See also the function next-command-event,
  2119. which is often more appropriate.
  2120.  
  2121. arguments:(event)
  2122. Fnext-command-event
  2123. Given an event structure, fills it in with the next keyboard, mouse
  2124. press, or mouse release event available from the user.  If there are
  2125. non-command events available (mouse motion, sub-process output, etc) then
  2126. these will be executed (with `dispatch-event') and discarded.  This 
  2127. function is provided as a convenience; it is equivalent to the elisp code
  2128.  
  2129.     (while (progn
  2130.         (next-event event)
  2131.             (not (or (key-press-event-p event)
  2132.                      (button-press-event-p event)
  2133.                      (button-release-event-p event)
  2134.                      (menu-event-p event))))
  2135.       (dispatch-event event))
  2136.  
  2137.  
  2138. arguments:(event)
  2139. Fread-char
  2140. Read a character from the command input (keyboard or macro).
  2141. If a mouse click is detected, an error is signalled.  The character typed
  2142. is returned as an ASCII value.  This is most likely the wrong thing for you
  2143. to be using: consider using the `next-command-event' function instead.
  2144.  
  2145. arguments:()
  2146. Fdiscard-input
  2147. Discard the contents of the terminal input buffer.
  2148. Also cancel any kbd macro being defined.
  2149.  
  2150. arguments:()
  2151. Faccept-process-output
  2152. Allow any pending output from subprocesses to be read by Emacs.
  2153. It is read into the process' buffers or given to their filter functions.
  2154. Non-nil arg PROCESS means do not return until some output has been received
  2155. from PROCESS.
  2156.  
  2157. arguments:(&optional proc)
  2158. Fsleep-for
  2159. Pause, without updating display, for ARG seconds.
  2160. ARG may be a float, meaning pause for some fractional part of a second.
  2161.  
  2162. arguments:(n)
  2163. Fsit-for
  2164. Perform redisplay, then wait for ARG seconds or until user input is
  2165. available.  ARG may be a float, meaning a fractional part of a second.
  2166. Optional second arg non-nil means don't redisplay, just wait for input.
  2167. Redisplay is preempted as always if user input arrives, and does not
  2168. happen if input is available before it starts.
  2169. Value is t if waited the full time with no input arriving.
  2170.  
  2171. arguments:(n &optional nodisp)
  2172. Fsleep-for-millisecs
  2173. Pause, without updating display, for ARG milliseconds.
  2174. This function is obsolete; call `sleep-for' with a float instead.
  2175.  
  2176. arguments:(n)
  2177. Fadd-timeout
  2178. SECS is a number of seconds, expressed as an integer or a float.
  2179. FUNCTION will be called after that many seconds have elapsed, with one
  2180. argument, the given OBJECT.  If the optional RESIGNAL argument is provided,
  2181. then after this timeout expires, `add-timeout' will automatically be called
  2182. again with RESIGNAL as the first argument.
  2183.  
  2184. This function returns an object which is the `id' of this particular timeout.
  2185. You can pass that object to `disable-timeout' to turn off the timeout before
  2186. it has been signalled.
  2187.  
  2188. The number of seconds may be expressed as a floating-point number, in which
  2189. case some fractional part of a second will be used.  Caveat: the usable
  2190. timeout granularity will vary from system to system.
  2191.  
  2192. Adding a timeout causes a timeout event to be returned by `next-event', and
  2193. the function will be invoked by `dispatch-event,' so if emacs is in a tight
  2194. loop, the function will not be invoked until the next call to sit-for or
  2195. until the return to top-level (the same is true of process filters.)
  2196.  
  2197. arguments:(secs function object &optional resignal)
  2198. Fdisable-timeout
  2199. Given a timeout id number as returned by `add-timeout', this function
  2200. will cause that timeout to not be signalled if it hasn't been already.
  2201.  
  2202. arguments:(id)
  2203. Fdispatch-event
  2204. Given an event object returned by next-event, execute it.
  2205.  
  2206. arguments:(event)
  2207. Fread-key-sequence
  2208. Read a sequence of keystrokes or mouse clicks and return a vector of the
  2209. event objects read.  The vector is newly created, but the event objects are
  2210. reused: if you want to hold a pointer to them beyond the next call to this
  2211. function, you must copy them first.
  2212.  
  2213. The sequence read is sufficient to specify a non-prefix command starting
  2214. from the current local and global keymaps.  A C-g typed while in this
  2215. function is treated like any other character, and `quit-flag' is not set.
  2216. One arg, PROMPT, is a prompt string, or nil meaning do not prompt specially.
  2217.  
  2218. If the user selects a menu item while we are prompting for a key-sequence,
  2219. the returned value will be a vector of a single menu-selection event.
  2220. An error will be signalled if you pass this value to `lookup-key' or a
  2221. related function.
  2222.  
  2223. arguments:(prompt)
  2224. Vecho-keystrokes
  2225. *Nonzero means echo unfinished commands after this many seconds of pause.Vauto-save-interval
  2226. *Number of keyboard input characters between auto-saves.
  2227. Zero means disable autosaving due to number of characters typed.
  2228. See also the variable `auto-save-timeout'.Fevent-to-character
  2229. Returns the closest ASCII approximation to the given event object.
  2230. If the event isn't a keypress, this returns nil.
  2231. If the second argument is non-nil, then this is lenient in its 
  2232. translation; it will ignore modifier keys other than control and meta,
  2233. and will ignore the shift modifier on those characters which have no 
  2234. shifted ASCII equivalent (Control-Shift-A for example, will be mapped to 
  2235. the same ASCII code as Control-A.)  If the second arg is nil, then nil 
  2236. will be returned for events which have no direct ASCII equivalent.
  2237.  
  2238. arguments:(event &optional lenient)
  2239. Fcharacter-to-event
  2240. Converts a numeric ASCII value to an event structure, replete with
  2241. bucky bits.  The character is the first argument, and the event to fill
  2242. in is the second.  This function contains knowledge about what the codes
  2243. ``mean'' -- for example, the number 9 is converted to the character ``Tab'',
  2244. not the distinct character ``Control-I''.
  2245.  
  2246. If the optional second argument is an event, it is modified; otherwise, a
  2247. new event object is created.
  2248.  
  2249. Beware that character-to-event and event-to-character are not strictly 
  2250. inverse functions, since events contain much more information than the 
  2251. ASCII character set can encode.
  2252.  
  2253. arguments:(ch &optional event)
  2254. Feventp
  2255. True if the argument is an event object.
  2256.  
  2257. arguments:(obj)
  2258. Fkey-press-event-p
  2259. True if the argument is a key-press event object.
  2260.  
  2261. arguments:(obj)
  2262. Fbutton-press-event-p
  2263. True if the argument is a mouse-button-press event object.
  2264.  
  2265. arguments:(obj)
  2266. Fbutton-release-event-p
  2267. True if the argument is a mouse-button-release event object.
  2268.  
  2269. arguments:(obj)
  2270. Fbutton-event-p
  2271. True if the argument is a button-press or button-release event object.
  2272.  
  2273. arguments:(obj)
  2274. Fmotion-event-p
  2275. True if the argument is a mouse-motion event object.
  2276.  
  2277. arguments:(obj)
  2278. Fprocess-event-p
  2279. True if the argument is a process-output event object.
  2280.  
  2281. arguments:(obj)
  2282. Ftimeout-event-p
  2283. True if the argument is a timeout event object.
  2284.  
  2285. arguments:(obj)
  2286. Fmenu-event-p
  2287. True if the argument is a menu event object.
  2288.  
  2289. arguments:(obj)
  2290. Feval-event-p
  2291. True if the argument is an `eval' or `menu' event object.
  2292.  
  2293. arguments:(obj)
  2294. Fevent-timestamp
  2295. Returns the timestamp of the given event object.
  2296.  
  2297. arguments:(event)
  2298. Fevent-key
  2299. Returns the KeySym of the given key-press event.  This will be the
  2300. ASCII code of a printing character, or a symbol.
  2301.  
  2302. arguments:(event)
  2303. Fevent-button
  2304. Returns the button-number of the given mouse-button-press event.
  2305.  
  2306. arguments:(event)
  2307. Fevent-modifier-bits
  2308. Returns a number representing the modifier keys which were down 
  2309. when the given mouse or keyboard event was produced.  See also the function
  2310. event-modifiers.
  2311.  
  2312. arguments:(event)
  2313. Fevent-modifiers
  2314. Returns a list of symbols, the names of the modifier keys which 
  2315. were down when the given mouse or keyboard event was produced.
  2316. See also the function event-modifier-bits.
  2317.  
  2318. arguments:(event)
  2319. Fevent-x-pixel
  2320. Returns the X position of the given mouse-motion, button-press, or
  2321. button-release event in pixels.
  2322.  
  2323. arguments:(event)
  2324. Fevent-y-pixel
  2325. Returns the Y position of the given mouse-motion, button-press, or
  2326. button-release event in pixels.
  2327.  
  2328. arguments:(event)
  2329. Fevent-window
  2330. Given a mouse motion, button press, or button release event, compute
  2331. and return the window on which that event occurred.  This may be nil if
  2332. the event did not occur in an emacs window (in the border or modeline.)
  2333.  
  2334. arguments:(event)
  2335. Fevent-point
  2336. Returns the character position of the given mouse-motion, button-press,
  2337. or button-release event.  If the event did not occur over a window, or did
  2338. not occur over text, then this returns nil.  Otherwise, it returns an index
  2339. into the buffer visible in the event's window.
  2340.  
  2341. arguments:(event)
  2342. Fevent-x
  2343. Returns the X position of the given mouse-motion, button-press, or
  2344. button-release event in characters.
  2345.  
  2346. arguments:(event)
  2347. Fevent-y
  2348. Returns the Y position of the given mouse-motion, button-press, or
  2349. button-release event in characters.
  2350.  
  2351. arguments:(event)
  2352. Fevent-glyph
  2353. If the given mouse-motion, button-press, or button-release event happened
  2354. on top of a glyph, this returns it; else nil.
  2355.  
  2356. arguments:(event)
  2357. Fevent-process
  2358. Returns the process of the given proces-output event.
  2359.  
  2360. arguments:(event)
  2361. Fevent-function
  2362. Returns the callback function of the given timeout, menu, or eval event.
  2363.  
  2364. arguments:(event)
  2365. Fevent-object
  2366. Returns the callback function argument of the given timeout, menu, or
  2367. eval event.
  2368.  
  2369. arguments:(event)
  2370. Vcharacter-set-property
  2371. A symbol used to look up the 8-bit character of a keysym.
  2372. To convert a keysym symbol to an 8-bit code, as when that key is
  2373. bound to self-insert-command, we will look up the property that this
  2374. variable names on the property list of the keysym-symbol.  The window-
  2375. system-specific code will set up appropriate properties and set this
  2376. variable.Fmap-extents
  2377. Usage: (map-extents FUNCTION BUFFER FROM TO MAPARG) 
  2378. Map FUNCTION over the extents which overlap region in BUFFER starting at
  2379.  FROM and ending at TO.  FUNCTION is called with arguments (extent, MAPARG).
  2380. All arguments except FUNCTION are optional, with FROM, TO, MAPARG, and
  2381.  BUFFER defaulting to the beginning of BUFFER, the end of BUFFER, NIL, and
  2382.  current buffer, respectively.
  2383. If the function returns non-nil, then map-extents returns immediately.
  2384. map-extents always returns nil.
  2385.  
  2386. arguments:(function &optional buffer from to maparg closed_end)
  2387. Fhighlight-extent
  2388. If EXTENT is `highlightable' (has the 'highlight property) then highlight
  2389. it (by using merging it with 'highlight face.)  If FLAG is nil, then
  2390. unhighlight it instead.
  2391.  
  2392. arguments:(extent_obj &optional flag)
  2393. Fforce-highlight-extent
  2394. Highlight any EXTENT if FLAG is not nil, else unhighlight it.
  2395. This is the same as `highlight-extent', except that it will work even
  2396. on extents without the 'highlight property.
  2397.  
  2398. arguments:(extent_obj &optional flag)
  2399. Fextent-start-position
  2400. Return start position of EXTENT.
  2401.  
  2402. arguments:(extent_obj)
  2403. Fextent-end-position
  2404. Return first position after EXTENT.
  2405.  
  2406. arguments:(extent_obj)
  2407. Fextent-length
  2408. Return length of EXTENT in characters.
  2409.  
  2410. arguments:(extent_obj)
  2411. Fextent-buffer
  2412. Return buffer of EXTENT.
  2413.  
  2414. arguments:(extent_obj)
  2415. Fextent-to-generic-id
  2416. Return Energize ID of buffer of EXTENT.
  2417.  
  2418. arguments:(extent_obj)
  2419. Fmake-extent
  2420. Make extent for range [FROM, TO) in BUFFER -- BUFFER defaults to 
  2421. current buffer.  Insertions at point TO will be outside of the extent;
  2422. insertions at FROM will be inside the extent (and the extent will grow.)
  2423.  
  2424. arguments:(from to &optional buffer)
  2425. Fdelete-extent
  2426. Remove EXTENT from its buffer; this does not modify the buffer's text,
  2427. only its display properties.
  2428.  
  2429. arguments:(extent_obj)
  2430. Fupdate-extent
  2431. Set the endpoints of EXTENT to START, END.
  2432.  
  2433. arguments:(extent_obj start end)
  2434. Fset-extent-attribute
  2435. Make EXTENT have ATTRIBUTE.
  2436. ATTRIBUTE must be one of the following symbols:
  2437.  
  2438.     highlight        highlight when the mouse moves over it
  2439.     write-protected    text within this extent will be unmodifyable
  2440.     invisible        don't display the text in this region
  2441.     unhighlight        turn off `highlight'
  2442.     writable        turn off `write-protected'
  2443.     visible        turn off `invisible'
  2444.  
  2445. arguments:(extent_obj attr)
  2446. Fextent-attributes
  2447. Return a list of attributes of EXTENT.
  2448. This list may contain any or none of the following symbols:
  2449.  
  2450.     highlight        highlight when the mouse moves over it
  2451.     write-protected    text within this extent will be unmodifyable
  2452.     invisible        don't display the text in this region
  2453.     begin-glyph        there is a begin-glyph
  2454.     end-glyph        there is an end-glyph
  2455.     detached        the text around the extent has been deleted
  2456.  
  2457. arguments:(extent_obj &optional raw_p)
  2458. Fset-extent-begin-glyph
  2459. Display a bitmap at the beginning of the given extent.
  2460. The begin-glyph should be a string naming a bitmap file (or nil.)
  2461.  
  2462. arguments:(extent_obj begin_glyph)
  2463. Fset-extent-end-glyph
  2464. Display a bitmap at the end of the given extent.
  2465. The end-glyph should be a string naming a bitmap file (or nil.)
  2466.  
  2467. arguments:(extent_obj end_glyph)
  2468. Fextent-data
  2469. Return the user data associated with the given extent.
  2470. Set this using the `set-extent-data' function.
  2471.  
  2472. arguments:(extent)
  2473. Fset-extent-data
  2474. Set the user data slot of the given extent.
  2475. Access this using the `extent-data' function.
  2476.  
  2477. arguments:(extent data)
  2478. Fextent-priority
  2479. Returns the display priority of EXTENT; see `set-extent-priority'.
  2480.  
  2481. arguments:(extent)
  2482. Fset-extent-priority
  2483. Changes the display priority of EXTENT.
  2484. When the extent attributes are being merged for display, the priority
  2485. is used to determine which extent takes precedence in the event of a
  2486. conflict (two extents whose faces both specify font, for example: the
  2487. font of the extent with the higher priority will be used.)
  2488. Extents are created with priority 0; priorities may be negative.
  2489.  
  2490. arguments:(extent pri)
  2491. Fextent-at
  2492. Find "smallest" extent at POS in BUFFER having FLAG set.  BUFFER
  2493. defaults to the current buffer, FLAG defaults to nil, meaning that any
  2494. extent will do. Possible values for FLAG are nil, 'menu, 'highlight,
  2495. 'invisible, and 'write-protected. Returns nil if there is no matching
  2496. extent at POS.
  2497.  
  2498. arguments:(pos &optional buffer flag)
  2499. Fnext-extent
  2500. Find next extent after EXTENT. If EXTENT is a buffer
  2501. return the first extent in the buffer.
  2502.  
  2503. arguments:(extent_obj)
  2504. Fnext-e-extent
  2505. Find next extent after EXTENT using the "e" order. If 
  2506. EXTENT is a buffer, return the first extent in the buffer.
  2507.  
  2508. arguments:(extent_obj)
  2509. Fstack-of-extents
  2510. Return stack of extents for BUFFER. Optional arg POSITION supplied
  2511. means compute the correct stack of extents for POSITION in BUFFER.
  2512.  
  2513. arguments:(buffer &optional position)
  2514. V   buffer-of-current-extent-fragment
  2515. Buffer for current extent fragment -- this is a GC hack.Fscreen-face-alist
  2516.  
  2517.  
  2518. arguments:(screen)
  2519. Fset-screen-face-alist
  2520.  
  2521.  
  2522. arguments:(screen value)
  2523. Fmake-face-internal
  2524.  
  2525.  
  2526. arguments:(name object id_number)
  2527. Fset-face-attribute-internal
  2528.  
  2529.  
  2530. arguments:(face_id attr_name attr_value screen)
  2531. Vmouse-highlight-priority
  2532. The priority to use for the mouse-highlighting pseudo-extent
  2533. that is used to highlight extents with the `highlight' attribute set.
  2534. See `set-extent-priority'.Ffile-name-directory
  2535. Return the directory component in file name NAME.
  2536. Return nil if NAME does not include a directory.
  2537. Otherwise return a directory spec.
  2538. Given a Unix syntax file name, returns a string ending in slash;
  2539. on VMS, perhaps instead a string ending in `:', `]' or `>'.
  2540.  
  2541. arguments:(file)
  2542. Ffile-name-nondirectory
  2543. Return file name NAME sans its directory.
  2544. For example, in a Unix-syntax file name,
  2545. this is everything after the last slash,
  2546. or the entire name if it contains no slash.
  2547.  
  2548. arguments:(file)
  2549. Ffile-name-as-directory
  2550. Return a string representing file FILENAME interpreted as a directory.
  2551. This operation exists because a directory is also a file, but its name as
  2552. a directory is different from its name as a file.
  2553. The result can be used as the value of `default-directory'
  2554. or passed as second argument to `expand-file-name'.
  2555. For a Unix-syntax file name, just appends a slash.
  2556. On VMS, converts "[X]FOO.DIR" to "[X.FOO]", etc.
  2557.  
  2558. arguments:(file)
  2559. Fdirectory-file-name
  2560. Returns the file name of the directory named DIR.
  2561. This is the name of the file that holds the data for the directory DIR.
  2562. This operation exists because a directory is also a file, but its name as
  2563. a directory is different from its name as a file.
  2564. In Unix-syntax, this function just removes the final slash.
  2565. On VMS, given a VMS-syntax directory name such as "[X.Y]",
  2566. it returns a file name such as "[X]Y.DIR.1".
  2567.  
  2568. arguments:(directory)
  2569. Fmake-temp-name
  2570. Generate temporary file name (string) starting with PREFIX (a string).
  2571. The Emacs process number forms part of the result,
  2572. so there is no danger of generating a name being used by another process.
  2573.  
  2574. arguments:(prefix)
  2575. Fexpand-file-name
  2576. Convert FILENAME to absolute, and canonicalize it.
  2577. Second arg DEFAULT is directory to start with if FILENAME is relative
  2578.  (does not start with slash); if DEFAULT is nil or missing,
  2579. the current buffer's value of default-directory is used.
  2580. Path components that are `.' are removed, and 
  2581. path components followed by `..' are removed, along with the `..' itself;
  2582. note that these simplifications are done without checking the resulting
  2583. paths in the file system.
  2584. An initial `~/' expands to your home directory.
  2585. An initial `~USER/' expands to USER's home directory.
  2586. See also the function `substitute-in-file-name'.
  2587.  
  2588. arguments:(name &optional defalt)
  2589. Ftruename
  2590. Returns the canonical name of the given FILE.
  2591. Second arg DEFAULT is directory to start with if FILE is relative
  2592.  (does not start with slash); if DEFAULT is nil or missing,
  2593.  the current buffer's value of default-directory is used.
  2594. No component of the resulting pathname will be a symbolic link, as
  2595.  in the realpath() function.
  2596. If the file does not exist, or is otherwise unable to be resolved,
  2597.  nil is returned.
  2598.  
  2599. arguments:(name &optional defalt)
  2600. Fsubstitute-in-file-name
  2601. Substitute environment variables referred to in FILENAME.
  2602. `$FOO' where FOO is an environment variable name means to substitute
  2603. the value of that variable.  The variable name should be terminated
  2604. with a character not a letter, digit or underscore; otherwise, enclose
  2605. the entire variable name in braces.
  2606. If `/~' appears, all of FILENAME through that `/' is discarded.
  2607.  
  2608. On VMS, `$' substitution is not done; this function does little and only
  2609. duplicates what `expand-file-name' does.
  2610.  
  2611. arguments:(string)
  2612. Fcopy-file
  2613. Copy FILE to NEWNAME.  Both args must be strings.
  2614. Signals a `file-already-exists' error if file NEWNAME already exists,
  2615. unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
  2616. A number as third arg means request confirmation if NEWNAME already exists.
  2617. This is what happens in interactive use with M-x.
  2618. Fourth arg KEEP-TIME non-nil means give the new file the same
  2619. last-modified time as the old one.  (This works on only some systems.)
  2620. A prefix arg makes KEEP-TIME non-nil.
  2621.  
  2622. arguments:(filename newname &optional ok_if_already_exists keep_date)
  2623. Fmake-directory
  2624. Create a directory.  One argument, a file name string.
  2625.  
  2626. arguments:(dirname)
  2627. Fremove-directory
  2628. Remove a directory.  One argument, a file name string.
  2629.  
  2630. arguments:(dirname)
  2631. Fdelete-file
  2632. Delete specified file.  One argument, a file name string.
  2633. If file has multiple names, it continues to exist with the other names.
  2634.  
  2635. arguments:(filename)
  2636. Frename-file
  2637. Rename FILE as NEWNAME.  Both args strings.
  2638. If file has names other than FILE, it continues to have those names.
  2639. Signals a `file-already-exists' error if a file NEWNAME already exists
  2640. unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
  2641. A number as third arg means request confirmation if NEWNAME already exists.
  2642. This is what happens in interactive use with M-x.
  2643.  
  2644. arguments:(filename newname &optional ok_if_already_exists)
  2645. Fadd-name-to-file
  2646. Give FILE additional name NEWNAME.  Both args strings.
  2647. Signals a `file-already-exists' error if a file NEWNAME already exists
  2648. unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
  2649. A number as third arg means request confirmation if NEWNAME already exists.
  2650. This is what happens in interactive use with M-x.
  2651.  
  2652. arguments:(filename newname &optional ok_if_already_exists)
  2653. Fmake-symbolic-link
  2654. Make a symbolic link to FILENAME, named LINKNAME.  Both args strings.
  2655. Signals a `file-already-exists' error if a file NEWNAME already exists
  2656. unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
  2657. A number as third arg means request confirmation if NEWNAME already exists.
  2658. This happens for interactive use with M-x.
  2659.  
  2660. arguments:(filename newname &optional ok_if_already_exists)
  2661. Fdefine-logical-name
  2662. Define the job-wide logical name NAME to have the value STRING.
  2663. If STRING is nil or a null string, the logical name NAME is deleted.
  2664.  
  2665. arguments:(varname string)
  2666. Fsysnetunam
  2667. Open a network connection to PATH using LOGIN as the login string.
  2668.  
  2669. arguments:(path login)
  2670. Ffile-name-absolute-p
  2671. Return t if file FILENAME specifies an absolute path name.
  2672. On Unix, this is a name starting with a `/' or a `~'.
  2673.  
  2674. arguments:(filename)
  2675. Ffile-exists-p
  2676. Return t if file FILENAME exists.  (This does not mean you can read it.)
  2677. See also `file-readable-p' and `file-attributes'.
  2678.  
  2679. arguments:(filename)
  2680. Ffile-executable-p
  2681. Return t if FILENAME can be executed by you.
  2682. For directories this means you can change to that directory.
  2683.  
  2684. arguments:(filename)
  2685. Ffile-readable-p
  2686. Return t if file FILENAME exists and you can read it.
  2687. See also `file-exists-p' and `file-attributes'.
  2688.  
  2689. arguments:(filename)
  2690. Ffile-symlink-p
  2691. If file FILENAME is the name of a symbolic link
  2692. returns the name of the file to which it is linked.
  2693. Otherwise returns NIL.
  2694.  
  2695. arguments:(filename)
  2696. Ffile-writable-p
  2697. Return t if file FILENAME can be written or created by you.
  2698.  
  2699. arguments:(filename)
  2700. Ffile-directory-p
  2701. Return t if file FILENAME is the name of a directory as a file.
  2702. A directory name spec may be given instead; then the value is t
  2703. if the directory so specified exists and really is a directory.
  2704.  
  2705. arguments:(filename)
  2706. Ffile-modes
  2707. Return mode bits of FILE, as an integer.
  2708.  
  2709. arguments:(filename)
  2710. Fset-file-modes
  2711. Set mode bits of FILE to MODE (an integer).
  2712. Only the 12 low bits of MODE are used.
  2713.  
  2714. arguments:(filename mode)
  2715. Ffile-newer-than-file-p
  2716. Return t if file FILE1 is newer than file FILE2.
  2717. If FILE1 does not exist, the answer is nil;
  2718. otherwise, if FILE2 does not exist, the answer is t.
  2719.  
  2720. arguments:(file1 file2)
  2721. Finsert-file-contents
  2722. Insert contents of file FILENAME after point.
  2723. Returns list of absolute pathname and length of data inserted.
  2724. If second argument VISIT is non-nil, the buffer's visited filename
  2725. and last save file modtime are set, and it is marked unmodified.
  2726. If visiting and the file does not exist, visiting is completed
  2727. before the error is signaled.
  2728.  
  2729. arguments:(filename &optional visit)
  2730. Fwrite-region
  2731. Write current region into specified file.
  2732. When called from a program, takes three arguments:
  2733. START, END and FILENAME.  START and END are buffer positions.
  2734. Optional fourth argument APPEND if non-nil means
  2735.   append to existing file contents (if any).
  2736. Optional fifth argument VISIT if t means
  2737.   set the last-save-file-modtime of buffer to this file's modtime
  2738.   and mark buffer not modified.
  2739. If VISIT is neither t nor nil, it means do not print
  2740.   the "Wrote file" message.
  2741. Kludgy feature: if START is a string, then that string is written
  2742. to the file, instead of any buffer contents, and END is ignored.
  2743.  
  2744. arguments:(start end filename &optional append visit)
  2745. Fencrypt-string
  2746. Encrypt STRING using KEY.
  2747.  
  2748. arguments:(string key)
  2749. Fdecrypt-string
  2750. Decrypt STRING using KEY.
  2751.  
  2752. arguments:(string key)
  2753. Fverify-visited-file-modtime
  2754. Return t if last mod time of BUF's visited file matches what BUF records.
  2755. This means that the file has not been changed since it was visited or saved.
  2756.  
  2757. arguments:(buf)
  2758. Fclear-visited-file-modtime
  2759. Clear out records of last mod time of visited file.
  2760. Next attempt to save will certainly not complain of a discrepancy.
  2761.  
  2762. arguments:()
  2763. Fset-visited-file-modtime
  2764. Update buffer's recorded modification time from the visited file's time.
  2765. Useful if the buffer was not read from the file normally
  2766. or if the file itself has been changed for some known benign reason.
  2767.  
  2768. arguments:()
  2769. Fset-buffer-modtime
  2770. Update BUFFER's recorded modification time from the associated 
  2771. file's modtime, if there is an associated file. If not, use the 
  2772. current time. In either case, if the optional arg TIME is supplied, use 
  2773. that is it is either an integer or a cons of two integers.
  2774.  
  2775. arguments:(buf &optional in_time)
  2776. Fdo-auto-save
  2777. Auto-save all buffers that need it.
  2778. This is all buffers that have auto-saving enabled
  2779. and are changed since last auto-saved.
  2780. Auto-saving writes the buffer into a file
  2781. so that your editing is not lost if the system crashes.
  2782. This file is not the file you visited; that changes only when you save.
  2783.  
  2784. Non-nil first argument means do not print any message if successful.
  2785.  
  2786. arguments:(&optional nomsg)
  2787. Fset-buffer-auto-saved
  2788. Mark current buffer as auto-saved with its current text.
  2789. No auto-save file will be written until the buffer changes again.
  2790.  
  2791. arguments:()
  2792. Frecent-auto-save-p
  2793. Return t if buffer has been auto-saved since last read in or saved.
  2794.  
  2795. arguments:()
  2796. Vvms-stmlf-recfm
  2797. *Non-nil means write new files with record format `stmlf'.
  2798. nil means use format `var'.  This variable is meaningful only on VMS.Flock-buffer
  2799. Lock FILE, if current buffer is modified.
  2800. FILE defaults to current buffer's visited file,
  2801. or else nothing is done if current buffer isn't visiting a file.
  2802.  
  2803. arguments:(&optional fn)
  2804. Funlock-buffer
  2805. Unlock the file visited in the current buffer,
  2806. if it should normally be locked.
  2807.  
  2808. arguments:()
  2809. Ffile-locked-p
  2810. Return nil if the FILENAME is not locked,
  2811. t if it is locked by you, else a string of the name of the locker.
  2812.  
  2813. arguments:(&optional fn)
  2814. Vlock-directory
  2815. Don't change thisVsuperlock-path
  2816. Don't change thisFacos
  2817. Return the inverse cosine of ARG.
  2818.  
  2819. arguments:(arg)
  2820. Facosh
  2821. Return the inverse hyperbolic cosine of ARG.
  2822.  
  2823. arguments:(arg)
  2824. Fasin
  2825. Return the inverse sine of ARG.
  2826.  
  2827. arguments:(arg)
  2828. Fasinh
  2829. Return the inverse hyperbolic sine of ARG.
  2830.  
  2831. arguments:(arg)
  2832. Fatan
  2833. Return the inverse tangent of ARG.
  2834.  
  2835. arguments:(arg1 &optional arg2)
  2836. Fatanh
  2837. Return the inverse hyperbolic tangent of ARG.
  2838.  
  2839. arguments:(arg)
  2840. Fcos
  2841. Return the cosine of ARG.
  2842.  
  2843. arguments:(arg)
  2844. Fcosh
  2845. Return the hyperbolic cosine of ARG.
  2846.  
  2847. arguments:(arg)
  2848. Fcube-root
  2849. Return the cube root of ARG.
  2850.  
  2851. arguments:(arg)
  2852. Fexp
  2853. Return the exponential base e of ARG.
  2854.  
  2855. arguments:(arg)
  2856. Flog
  2857. Return the natural logarithm of ARG.
  2858. With two arguments, return the logarithm of ARG to the base ARG2.
  2859.  
  2860. arguments:(arg1 &optional arg2)
  2861. Flog10
  2862. Return the logarithm base 10 of ARG.
  2863.  
  2864. arguments:(arg)
  2865. Fexpt
  2866. Return the exponential x ** y.
  2867.  
  2868. arguments:(arg1 arg2)
  2869. Fsin
  2870. Return the sine of ARG.
  2871.  
  2872. arguments:(arg)
  2873. Fsinh
  2874. Return the hyperbolic sine of ARG.
  2875.  
  2876. arguments:(arg)
  2877. Fsqrt
  2878. Return the square root of ARG.
  2879.  
  2880. arguments:(arg)
  2881. Ftan
  2882. Return the tangent of ARG.
  2883.  
  2884. arguments:(arg)
  2885. Ftanh
  2886. Return the hyperbolic tangent of ARG.
  2887.  
  2888. arguments:(arg)
  2889. Fabs
  2890. Return the absolute value of ARG.
  2891.  
  2892. arguments:(arg)
  2893. Ffloat
  2894. Return the floating point number equal to ARG.
  2895.  
  2896. arguments:(arg)
  2897. Fceiling
  2898. Return the smallest integer no less than ARG.  (Round toward +inf.)
  2899.  
  2900. arguments:(arg)
  2901. Ffloor
  2902. Return the largest integer no greater than ARG.  (Round towards -inf.)
  2903.  
  2904. arguments:(arg)
  2905. Fround
  2906. Return the nearest integer to ARG.
  2907.  
  2908. arguments:(arg)
  2909. Ftruncate
  2910. Truncate a floating point number to an int.
  2911. Rounds the value toward zero.
  2912.  
  2913. arguments:(arg)
  2914. Ffceiling
  2915. Return the smallest integer no less than ARG, as a float.
  2916. (Round toward +inf.)
  2917.  
  2918. arguments:(arg)
  2919. Fffloor
  2920. Return the largest integer no greater than ARG, as a float.
  2921. (Round towards -inf.)
  2922.  
  2923. arguments:(arg)
  2924. Ffround
  2925. Return the nearest integer to ARG, as a float.
  2926.  
  2927. arguments:(arg)
  2928. Fftruncate
  2929. Truncate a floating point number to an integral float value.
  2930. Rounds the value toward zero.
  2931.  
  2932. arguments:(arg)
  2933. Fidentity
  2934. Return the argument unchanged.
  2935.  
  2936. arguments:(arg)
  2937. Frandom
  2938. Return a pseudo-random number.
  2939. On most systems all integers representable in Lisp are equally likely.
  2940.   This is 24 bits' worth.
  2941. With argument N, return random number in interval [0,N).
  2942. With argument t, set the random number seed from the current time and pid.
  2943.  
  2944. arguments:(&optional arg)
  2945. Flength
  2946. Return the length of vector, list or string SEQUENCE.
  2947. A byte-code function object is also allowed.
  2948.  
  2949. arguments:(obj)
  2950. Fstring-equal
  2951. T if two strings have identical contents.
  2952. Case is significant.
  2953. Symbols are also allowed; their print names are used instead.
  2954.  
  2955. arguments:(s1 s2)
  2956. Fstring-lessp
  2957. T if first arg string is less than second in lexicographic order.
  2958. Case is significant.
  2959. Symbols are also allowed; their print names are used instead.
  2960.  
  2961. arguments:(s1 s2)
  2962. Fappend
  2963. Concatenate all the arguments and make the result a list.
  2964. The result is a list whose elements are the elements of all the arguments.
  2965. Each argument may be a list, vector or string.
  2966. The last argument is not copied if it is a list.
  2967.  
  2968. arguments: (&rest args)
  2969. Fconcat
  2970. Concatenate all the arguments and make the result a string.
  2971. The result is a string whose elements are the elements of all the arguments.
  2972. Each argument may be a string, a list of numbers, or a vector of numbers.
  2973.  
  2974. arguments: (&rest args)
  2975. Fvconcat
  2976. Concatenate all the arguments and make the result a vector.
  2977. The result is a vector whose elements are the elements of all the arguments.
  2978. Each argument may be a list, vector or string.
  2979.  
  2980. arguments: (&rest args)
  2981. Fcopy-sequence
  2982. Return a copy of a list, vector or string.
  2983. The elements of a list or vector are not copied; they are shared
  2984. with the original.
  2985.  
  2986. arguments:(arg)
  2987. Fcopy-alist
  2988. Return a copy of ALIST.
  2989. This is an alist which represents the same mapping from objects to objects,
  2990. but does not share the alist structure with ALIST.
  2991. The objects mapped (cars and cdrs of elements of the alist)
  2992. are shared, however.
  2993.  
  2994. arguments:(alist)
  2995. Fcopy-tree
  2996. Return a copy of a list or vector, and substructures.
  2997. The argument is copied, and any lists or vectors contained within it
  2998. are copied recursively.  Circularities and shared substructures are
  2999. not preserved.  Strings are not copied.
  3000.  
  3001. arguments:(arg)
  3002. Fsubstring
  3003. Return a substring of STRING, starting at index FROM and ending before TO.
  3004. TO may be nil or omitted; then the substring runs to the end of STRING.
  3005. If FROM or TO is negative, it counts from the end.
  3006.  
  3007. arguments:(string from &optional to)
  3008. Fnthcdr
  3009. Take cdr N times on LIST, returns the result.
  3010.  
  3011. arguments:(n list)
  3012. Fnth
  3013. Return the Nth element of LIST.
  3014. N counts from zero.  If LIST is not that long, nil is returned.
  3015.  
  3016. arguments:(n list)
  3017. Felt
  3018. Return element of SEQUENCE at index N.
  3019.  
  3020. arguments:(seq n)
  3021. Fmember
  3022. Return non-nil if ELT is an element of LIST.  Comparison done with EQUAL.
  3023. The value is actually the tail of LIST whose car is ELT.
  3024.  
  3025. arguments:(elt list)
  3026. Fmemq
  3027. Return non-nil if ELT is an element of LIST.  Comparison done with EQ.
  3028. The value is actually the tail of LIST whose car is ELT.
  3029.  
  3030. arguments:(elt list)
  3031. Fassq
  3032. Return non-nil if ELT is `eq' to the car of an element of LIST.
  3033. The value is actually the element of LIST whose car is ELT.
  3034.  
  3035. arguments:(key list)
  3036. Fassoc
  3037. Return non-nil if ELT is `equal' to the car of an element of LIST.
  3038. The value is actually the element of LIST whose car is ELT.
  3039.  
  3040. arguments:(key list)
  3041. Frassq
  3042. Return non-nil if ELT is `eq' to the cdr of an element of LIST.
  3043. The value is actually the element of LIST whose cdr is ELT.
  3044.  
  3045. arguments:(key list)
  3046. Fdelq
  3047. Delete by side effect any occurrences of ELT as a member of LIST.
  3048. The modified LIST is returned.  Comparison is done with `eq'.
  3049. If the first member of LIST is ELT, there is no way to remove it by side effect;
  3050. therefore, write `(setq foo (delq element foo))'
  3051. to be sure of changing the value of `foo'.
  3052.  
  3053. arguments:(elt list)
  3054. Fdelete
  3055. Delete by side effect any occurrences of ELT as a member of LIST.
  3056. The modified LIST is returned.  Comparison is done with `equal'.
  3057. If the first member of LIST is ELT, there is no way to remove it by side effect;
  3058. therefore, write `(setq foo (delete element foo))'
  3059. to be sure of changing the value of `foo'.
  3060.  
  3061. arguments:(elt list)
  3062. Fnreverse
  3063. Reverse LIST by modifying cdr pointers.
  3064. Returns the beginning of the reversed list.
  3065.  
  3066. arguments:(list)
  3067. Freverse
  3068. Reverse LIST, copying.  Returns the beginning of the reversed list.
  3069. See also the function `nreverse', which is used more often.
  3070.  
  3071. arguments:(list)
  3072. Fsort
  3073. Sort LIST, stably, comparing elements using PREDICATE.
  3074. Returns the sorted list.  LIST is modified by side effects.
  3075. PREDICATE is called with two elements of LIST, and should return T
  3076. if the first element is "less" than the second.
  3077.  
  3078. arguments:(list pred)
  3079. Fget
  3080. Return the value of SYMBOL's PROPNAME property.
  3081. This is the last VALUE stored with `(put SYMBOL PROPNAME VALUE)'.
  3082.  
  3083. arguments:(sym prop)
  3084. Fput
  3085. Store SYMBOL's PROPNAME property with value VALUE.
  3086. It can be retrieved with `(get SYMBOL PROPNAME)'.
  3087.  
  3088. arguments:(sym prop val)
  3089. Fremprop
  3090. Remove from SYMBOL's plist the property PROP and its value.
  3091.  
  3092. arguments:(symbol property)
  3093. Fequal
  3094. T if two Lisp objects have similar structure and contents.
  3095. They must have the same data type.
  3096. Conses are compared by comparing the cars and the cdrs.
  3097. Vectors and strings are compared element by element.
  3098. Numbers are compared by value.  Symbols must match exactly.
  3099.  
  3100. arguments:(o1 o2)
  3101. Ffillarray
  3102. Store each element of ARRAY with ITEM.  ARRAY is a vector or string.
  3103.  
  3104. arguments:(array item)
  3105. Fnconc
  3106. Concatenate any number of lists by altering them.
  3107. Only the last argument is not altered, and need not be a list.
  3108.  
  3109. arguments: (&rest args)
  3110. Fmapconcat
  3111. Apply FN to each element of SEQ, and concat the results as strings.
  3112. In between each pair of results, stick in SEP.
  3113. Thus, " " as SEP results in spaces between the values return by FN.
  3114.  
  3115. arguments:(fn seq sep)
  3116. Fmapcar
  3117. Apply FUNCTION to each element of SEQUENCE, and make a list of the results.
  3118. The result is a list just as long as SEQUENCE.
  3119. SEQUENCE may be a list, a vector or a string.
  3120.  
  3121. arguments:(fn seq)
  3122. Fload-average
  3123. Return list of 1 minute, 5 minute and 15 minute load averages.
  3124. Each of the three load averages is multiplied by 100,
  3125. then converted to integer.
  3126.  
  3127. This won't work unless the emacs executable is setgid kmem
  3128. (assuming that /dev/kmem is in the group kmem.)
  3129.  
  3130. arguments:()
  3131. Ffeaturep
  3132. Returns t if FEATURE is present in this Emacs.
  3133. Use this to conditionalize execution of lisp code based on the presence or
  3134. absence of emacs or environment extensions.
  3135. Use `provide' to declare that a feature is available.
  3136. This function looks at the value of the variable `features'.
  3137.  
  3138. arguments:(feature)
  3139. Fprovide
  3140. Announce that FEATURE is a feature of the current Emacs.
  3141.  
  3142. arguments:(feature)
  3143. Frequire
  3144. If feature FEATURE is not loaded, load it from FILENAME.
  3145. If FEATURE is not a member of the list `features', then the feature
  3146. is not loaded; so load the file FILENAME.
  3147. If FILENAME is omitted, the printname of FEATURE is used as the file name.
  3148.  
  3149. arguments:(feature &optional file_name)
  3150. Fplay-sound-file
  3151. Play the named sound file on the console speaker at the specified volume
  3152. (0-100, default specified by the `bell-volume' variable).
  3153. The sound file must be in the Sun/NeXT U-LAW format.
  3154.  
  3155. arguments:(file &optional vol)
  3156. Fplay-sound
  3157. Play a sound of the provided type.
  3158. See the variable sound-alist.
  3159.  
  3160. arguments:(sound &optional volume)
  3161. Vfeatures
  3162. A list of symbols which are the features of the executing emacs.
  3163. Used by `featurep' and `require', and altered by `provide'.Vbell-volume
  3164. How loud to be, from 0 to 100.Vsound-alist
  3165. An alist associating symbols with strings of audio-data.
  3166. When `beep' or `ding' is called with one of the symbols, the associated
  3167. sound data will be played instead of the standard beep.  This only works
  3168. if you are logged in on the console of a Sun SparcStation or SGI machine.
  3169.  
  3170. Elements of this list should be of one of the following forms:
  3171.  
  3172.    ( symbol . string-or-symbol )
  3173.    ( symbol integer string-or-symbol )
  3174.  
  3175. If the `string-or-symbol' is a string, then it should contain raw sound data,
  3176. the contents of a `.au' file.  If it is a symbol, then that means that this
  3177. element is an alias for some other element, and the sound-player will look
  3178. for that next.  If the integer is provided, it is the volume at which the
  3179. sound should be played, from 0 to 100.  
  3180.  
  3181. If an element of this alist begins with the symbol `default', then that sound
  3182. will be used when no other sound is appropriate.
  3183.  
  3184. The symbol `t' in place of a sound-string means to use the default X beep.
  3185. In this way, you can define beep-types to have different volumes even when
  3186. not running on the console of a Sun4.
  3187.  
  3188. You should probably add things to this list by calling the function
  3189. load-sound-file.
  3190.  
  3191. The following beep-types are used by emacs itself:
  3192.  
  3193.     auto-save-error    when an auto-save does not succeed
  3194.     command-error    when the emacs command loop catches an error
  3195.     undefined-key    when you type a key that is undefined
  3196.     undefined-click    when you use an undefined mouse-click combination
  3197.     no-completion    during completing-read
  3198.     y-or-n-p        when you type something other than 'y' or 'n'
  3199.     yes-or-no-p      when you type something other than 'yes' or 'no'
  3200.  
  3201. Other lisp packages may use other beep types, but these are the ones that
  3202. the C kernel of emacs uses.Fbuffer-syntactic-context-flush-cache
  3203. Flush the cache used by `buffer-syntactic-context-flush-cache'.
  3204. Call this when deletions occur.  This is a kludge.
  3205.  
  3206. arguments:()
  3207. Fbuffer-syntactic-context
  3208. Returns the syntactic context of the current buffer at point.
  3209. The returned value is one of the following symbols:
  3210.  
  3211.     nil        ; meaning no special interpretation
  3212.     string        ; meaning point is within a string
  3213.     comment        ; meaning point is within a line comment
  3214.     block-comment    ; meaning point is within a block comment
  3215.  
  3216. See also the function `buffer-syntactic-context-depth', which returns
  3217. the current nesting-depth within all parenthesis-syntax delimiters
  3218. and the function `syntactically-sectionize', which will map a function
  3219. over each syntactic context in a region.
  3220.  
  3221. arguments:()
  3222. Fbuffer-syntactic-context-depth
  3223. Returns the depth within all parenthesis-syntax delimiters at point.
  3224.  
  3225. arguments:()
  3226. Fsyntactically-sectionize
  3227. Creates extents for each contiguous syntactic context in the region.
  3228. Calls the given function when each extent is created with three arguments:
  3229. the extent, a symbol representing the syntactic context, and the current
  3230. depth (as returned by the functions `buffer-syntactic-context' and
  3231. `buffer-syntactic-context-depth').  If the optional arg `extent-data' is
  3232. provided, the extent will be created with that in its data slot.
  3233.  
  3234. arguments:(start end function &optional extent_data)
  3235. Fcurrent-column
  3236. Return the horizontal position of point.  Beginning of line is column 0.
  3237. This is calculated by adding together the widths of all the displayed
  3238. representations of the character between the start of the previous line
  3239. and point.  (eg control characters will have a width of 2 or 4, tabs
  3240. will have a variable width)
  3241. Ignores finite width of screen, which means that this function may return
  3242. values greater than (screen-width).
  3243. Whether the line is visible (if `selective-display' is t) has no effect;
  3244. however, ^M is treated as end of line when `selective-display' is t.
  3245.  
  3246. arguments:()
  3247. Findent-to
  3248. Indent from point with tabs and spaces until COLUMN is reached.
  3249. Optional second argument MIN says always do at least MIN spaces
  3250. even if that goes past COLUMN; by default, MIN is zero.
  3251.  
  3252. arguments:(col &optional minimum)
  3253. Fcurrent-indentation
  3254. Return the indentation of the current line.
  3255. This is the horizontal position of the character
  3256. following any initial whitespace.
  3257.  
  3258. arguments:()
  3259. Fmove-to-column
  3260. Move point to column COLUMN in the current line.
  3261. The column of a character is calculated by adding together the widths
  3262. as displayed of the previous characters in the line.
  3263. This function ignores line-continuation;
  3264. there is no upper limit on the column number a character can have
  3265. and horizontal scrolling has no effect.
  3266.  
  3267. If specified column is within a character, point goes after that character.
  3268. If it's past end of line, point goes to end of line.
  3269.  
  3270. A non-nil second (optional) argument FORCE means, if the line
  3271. is too short to reach column COLUMN then add spaces/tabs to get there,
  3272. and if COLUMN is in the middle of a tab character, change it to spaces.
  3273.  
  3274. arguments:(column &optional force)
  3275. Fmotion
  3276. Move forward from point by N characters.  Stop if we reach
  3277. TOHPOS, TOVPOS first.
  3278.  
  3279. arguments:(n tohpos tovpos)
  3280. Fvertical-motion
  3281. Move to start of screen line LINES lines down.
  3282. If LINES is negative, this is moving up.
  3283. Sets point to position found; this may be start of line
  3284.  or just the start of a continuation line.
  3285. Returns number of lines moved; may be closer to zero than LINES
  3286.  if beginning or end of buffer was reached.
  3287. Optional second argument is WINDOW to move in.
  3288.  
  3289. arguments:(lines &optional window)
  3290. Vindent-tabs-mode
  3291. *Indentation can insert tabs if this is non-nil.
  3292. Setting this variable automatically makes it local to the current buffer.Frecursive-edit
  3293. Invoke the editor command loop recursively.
  3294. To get out of the recursive edit, a command can do `(throw 'exit nil)';
  3295. that tells this function to return.
  3296. Alternately, `(throw 'exit t)' makes this function signal an error.
  3297. This function is called by the editor initialization to begin editing.
  3298.  
  3299. arguments:()
  3300. Ftop-level
  3301. Exit all recursive editing levels.
  3302.  
  3303. arguments:()
  3304. Fexit-recursive-edit
  3305. Exit from the innermost recursive edit or minibuffer.
  3306.  
  3307. arguments:()
  3308. Fabort-recursive-edit
  3309. Abort the command that requested this recursive edit or minibuffer input.
  3310.  
  3311. arguments:()
  3312. Fcommand-execute
  3313. Execute CMD as an editor command.
  3314. CMD must be a symbol that satisfies the `commandp' predicate.
  3315. Optional second arg RECORD-FLAG non-nil
  3316. means unconditionally put this command in `command-history'.
  3317. Otherwise, that is done only if an arg is read using the minibuffer.
  3318.  
  3319. arguments:(cmd &optional record)
  3320. Frecent-keys
  3321. Return vector of last 100 keyboard or mouse button events read.
  3322. This copies 100 event objects and a vector; it is safe to keep and modify
  3323. them.
  3324.  
  3325. arguments:()
  3326. Fthis-command-keys
  3327. Returns a vector of the keyboard or mouse button events that were used
  3328. to invoke this command.  This copies the vector and the events; it is safe
  3329. to keep and modify them.
  3330.  
  3331. arguments:()
  3332. Frecursion-depth
  3333. Return the current depth in recursive edits.
  3334.  
  3335. arguments:()
  3336. Fopen-dribble-file
  3337. Start writing all keyboard characters to FILE.
  3338.  
  3339. arguments:(file)
  3340. Fsuspend-emacs
  3341. Stop Emacs and return to superior process.  You can resume later.
  3342. If optional arg STUFFSTRING is non-nil, its characters are stuffed
  3343. to be read as terminal input by Emacs's superior shell.
  3344. Before suspending, if `suspend-hook' is bound and value is non-nil
  3345. call the value as a function of no args.  Don't suspend if it returns non-nil.
  3346. Otherwise, suspend normally and after resumption call
  3347. `suspend-resume-hook' if that is bound and non-nil.
  3348.  
  3349. arguments:(&optional stuffstring)
  3350. Fset-input-mode
  3351. Set mode of reading keyboard input.
  3352. First arg non-nil means use input interrupts; nil means use CBREAK mode.
  3353. Second arg non-nil means use ^S/^Q flow control for output to terminal
  3354.  (no effect except in CBREAK mode).
  3355. Third arg non-nil means accept 8-bit input (for a Meta key).
  3356.  Otherwise, the top bit is ignored, on the assumption it is parity.
  3357.  
  3358. arguments:(intrrupt flow meta)
  3359. Fset-interrupt-character
  3360. Change the interrupt character.  Arg is an ASCII code or nil.
  3361. Among other system-dependent things, this changes the value of the
  3362. variable `interrupt-char'.
  3363.  
  3364. arguments:(new_interrupt_char)
  3365. Vdisabled-command-hook
  3366. Value is called instead of any command that is disabled,
  3367. i.e. has a non-nil `disabled' property.Vlast-command-event
  3368. Last keyboard or mouse button event that was part of a command.  This
  3369. variable is off limits: you may not set its value or modify the event that
  3370. is its value, as it is destructively modified by `read-key-sequence'.  If
  3371. you want to keep a pointer to this value, you must use `copy-event'.Vlast-command-char
  3372. If the value of `last-command-event' is a keyboard event, then
  3373. this is the nearest ASCII equivalent to it.  This the the value that
  3374. `self-insert-command' will put in the buffer.  Remember that there is
  3375. NOT a 1:1 mapping between keyboard events and ASCII characters: the set
  3376. of keyboard events is much larger, so writing code that examines this
  3377. variable to determine what key has been typed is bad practice, unless
  3378. you are certain that it will be one of a small set of characters.Vlast-input-event
  3379. Last keyboard or mouse button event recieved.  This variable is off
  3380. limits: you may not set its value or modify the event that is its value, as
  3381. it is destructively modified by `next-event'.  If you want to keep a pointer
  3382. to this value, you must use `copy-event'.Vlast-input-char
  3383. If the value of `last-input-event' is a keyboard event, then
  3384. this is the nearest ASCII equivalent to it.  Remember that there is
  3385. NOT a 1:1 mapping between keyboard events and ASCII characters: the set
  3386. of keyboard events is much larger, so writing code that examines this
  3387. variable to determine what key has been typed is bad practice, unless
  3388. you are certain that it will be one of a small set of characters.Vlast-input-time
  3389. The time (in seconds since Jan 1, 1970) of the last-command-event,
  3390. represented as a cons of two 16-bit integers.  This is destructively
  3391. modified, so copy it if you want to keep it.Vunread-command-event
  3392. Set this to an event object to simulate the reciept of an event from
  3393. the user.  Normally this is nil.Vlast-command
  3394. The last command executed.  Normally a symbol with a function definition,
  3395. but can be whatever was found in the keymap, or whatever the variable
  3396. `this-command' was set to by that command.Vthis-command
  3397. The command now being executed.
  3398. The command can set this variable; whatever is put here
  3399. will be in `last-command' during the following command.Vhelp-char
  3400. Character to recognize as meaning Help.
  3401. When it is read, do `(eval help-form)', and display result if it's a string.
  3402. If the value of `help-form' is nil, this char can be read normally.Vinterrupt-char
  3403. Character which interrupts emacs.
  3404. Do not setq this variable: use the function `set-interrupt-character' instead.
  3405. Depending on the system you are on, this may need to do magic like changing
  3406. interrupt handlers.Vhelp-form
  3407. Form to execute when character help-char is read.
  3408. If the form returns a string, that string is displayed.
  3409. If `help-form' is nil, the help char is not recognized.Vpre-command-hook
  3410. Function or functions to run before every command.
  3411. This may examine the `this-command' variable to find out what command
  3412. is about to be run, or may change it to cause a different command to run.
  3413. Function on this hook must be careful to avoid signalling errors!Vpost-command-hook
  3414. Function or functions to run after every command.
  3415. This may examine the `this-command' variable to find out what command
  3416. was just executed.Vtop-level
  3417. Form to evaluate when Emacs starts up.
  3418. Useful to set before you dump a modified Emacs.Vkeyboard-translate-table
  3419. String used as translate table for keyboard input, or nil.
  3420. Each character is looked up in this string and the contents used instead.
  3421. If string is of length N, character codes N and up are untranslated.
  3422. This is the right thing to use only if you are on a dumb tty, as it cannot
  3423. handle input which cannot be represented as ASCII.  If you are running emacs
  3424. under X, you should do the translations with the `xmodmap' program instead.Fmake-keymap
  3425. Construct and return a new keymap object.  All entries in it are nil,
  3426. meaning "command undefined".
  3427.  
  3428. arguments:()
  3429. Fmake-sparse-keymap
  3430. Construct and return a new keymap object.  All entries in it are nil,
  3431. meaning "command undefined".  The only difference between this function
  3432. and make-keymap is that this function returns a "smaller" keymap (one
  3433. that is expected to contain less entries.)  As keymaps dynamically resize,
  3434. the distinction is not great.
  3435.  
  3436. arguments:()
  3437. Fkeymap-parent
  3438. Returns the `parent' keymap of the given keymap, or nil.
  3439. The parent of a keymap is searched for keybindings when a key sequence
  3440. isn't bound in this one.  The (current-global-map) is the default parent
  3441. of all keymaps.
  3442.  
  3443. arguments:(keymap)
  3444. Fset-keymap-parent
  3445. Sets the `parent' keymap of the given keymap.
  3446. The parent of a keymap is searched for keybindings when a key sequence
  3447. isn't bound in this one.  The (current-global-map) is the default parent
  3448. of all keymaps.
  3449.  
  3450. arguments:(keymap parent)
  3451. Fset-keymap-name
  3452. Sets the `name' of the given keymap to NEW-NAME
  3453. The name is only a debugging convenience; it is not used except
  3454. when printing the keymap.
  3455.  
  3456. arguments:(keymap new_name)
  3457. Fkeymapp
  3458. Return t if ARG is a keymap object.
  3459.  
  3460. arguments:(object)
  3461. Fcopy-keymap
  3462. Return a copy of the keymap KEYMAP.
  3463. The copy starts out with the same definitions of KEYMAP,
  3464. but changing either the copy or KEYMAP does not affect the other.
  3465. Any key definitions that are subkeymaps are recursively copied.
  3466.  
  3467. arguments:(keymap)
  3468. Fkeymap-fullness
  3469. Returns the number of bindings in the keymap.
  3470.  
  3471. arguments:(keymap)
  3472. Fdefine-key
  3473. Args KEYMAP, KEYS, DEF.  Define key sequence KEYS, in KEYMAP, as DEF.
  3474. KEYMAP is a keymap object.
  3475. KEYS is the sequence of keystrokes to bind, described below.
  3476. DEF is anything that can be a key's definition:
  3477.  nil (means key is undefined in this keymap);
  3478.  a command (a Lisp function suitable for interactive calling);
  3479.  a string or key sequence vector (treated as a keyboard macro);
  3480.  a keymap (to define a prefix key);
  3481.  a symbol; when the key is looked up, the symbol will stand for its
  3482.     function definition, that should at that time be one of the above,
  3483.     or another symbol whose function definition is used, and so on.
  3484.  a cons (STRING . DEFN), meaning that DEFN is the definition
  3485.     (DEFN should be a valid definition in its own right);
  3486.  or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP.
  3487.  
  3488. Contrary to popular belief, the world is not ASCII.  When running under a
  3489. window manager, Emacs can tell the difference between, for example, the
  3490. keystrokes control-h, control-shift-h, and backspace.  You can, in fact,
  3491. bind different commands to each of these.
  3492.  
  3493. A `key sequence' is a set of keystrokes.  A `keystroke' is a keysym and some
  3494. set of modifiers (such as control and meta).  A `keysym' is what is printed
  3495. on the keys on your keyboard.
  3496.  
  3497. A keysym may be represented by a symbol, or (if and only if it is equivalent
  3498. to a printing ASCII character) by its ASCII code.  The `A' key may be
  3499. represented by the symbol `A' or by the number 65.  The `break' key may be
  3500. represented only by the symbol `break'.
  3501.  
  3502. A keystroke may be represented by a list: the last element of the list is
  3503. the key (a symbol or number, as above) and the preceding elements are the
  3504. symbolic names of modifier keys (control, meta, super, hyper, and shift.)
  3505. Thus, the sequence control-b is represented by the forms `(control b)' 
  3506. and `(control 98)'.  A keystroke may also be represented by an event object,
  3507. as returned by the `next-command-event' and `read-key-sequence' functions.
  3508.  
  3509. Note that in this context, the keystroke `control-b' is *not* represented
  3510. by the number 2 (the ASCII code for ^B).  See below.
  3511.  
  3512. The `shift' modifier is somewhat of a special case.  You should not (and
  3513. cannot) use `(meta shift a)' to mean `(meta A)', since for characters that
  3514. have printing ASCII equivalents, the state of the shift key is implicit in
  3515. the keysym (a vs. A).  You also cannot say `(shift =)' to mean `+', as that
  3516. sort of thing varies from keyboard to keyboard.  The shift modifier is for
  3517. use only with characters that do not have a second keysym on the same key,
  3518. such as `backspace' and `tab'.
  3519.  
  3520. A key sequence is a vector of keystrokes.  As a degenerate case, elements
  3521. of this vector may also be keysyms if they have no modifiers.  That is,
  3522. the `A' keystroke is represented by all of these forms:
  3523.     A    65    (A)    (65)    [A]    [65]    [(A)]    [(65)]
  3524. the `control-a' keystroke is represented by these forms:
  3525.     (control A)    (control 65)    [(control A)]    [(control 65)]
  3526. the key sequence `control-c control-a' is represented by these forms:
  3527.     [(control c) (control a)]    [(control 99) (control 65)]
  3528.  
  3529. Mouse button clicks work just like keypresses: (control button1) means
  3530. pressing the left mouse button while holding down the control key.
  3531. [(control c) (shift button3)] means control-c, hold shift, click right.
  3532.  
  3533. Commands may be bound to the mouse-button up-stroke rather than the down-
  3534. stroke as well.  `button1' means the down-stroke, and `button1up' means the
  3535. up-stroke.  Different commands may be bound to the up and down strokes,
  3536. though that is probably not what you want, so be careful.
  3537.  
  3538. For backward compatibility, a key sequence may also be represented by a
  3539. string.  In this case, it represents the key sequence(s) that would
  3540. produce that sequence of ASCII characters in a purely ASCII world.  For
  3541. example, a string containing the ASCII backspace character, "\^H", would
  3542. represent two key sequences: `(control h)' and `backspace'.  Binding a
  3543. command to this will actually bind both of those key sequences.  Likewise
  3544. for the following pairs:
  3545.  
  3546.         control h    backspace
  3547.         control i       tab
  3548.         control m       return
  3549.         control j       linefeed
  3550.         control [       escape
  3551.         control @    control space
  3552.  
  3553. After binding a command to two key sequences with a form like
  3554.  
  3555.     (define-key global-map "\^X\^I" 'command-1)
  3556.  
  3557. it is possible to redefine only one of those sequences like so:
  3558.  
  3559.     (define-key global-map [(control x) (control i)] 'command-2)
  3560.     (define-key global-map [(control x) tab] 'command-3)
  3561.  
  3562. Of course, all of this applies only when running under a window system.  If
  3563. you're talking to emacs through an ASCII-only channel, you don't get any of
  3564. these features.
  3565.  
  3566. arguments:(keymap keys def)
  3567. Flookup-key
  3568. In keymap KEYMAP, look up key sequence KEYS.  Return the definition.
  3569. nil means undefined.  See doc of `define-key' for kinds of definitions
  3570. and key-sequence specifications.
  3571. Number as value means KEYS is "too long";
  3572. that is, characters in it except for the last one
  3573. fail to be a valid sequence of prefix characters in KEYMAP.
  3574. The number is how many characters at the front of KEYS
  3575. it takes to reach a non-prefix command.
  3576.  
  3577. arguments:(keymap keys)
  3578. Fkey-binding
  3579. Return the binding for command KEYS in current keymaps.
  3580. KEYS is a string, a vector of events, or a vector of key-description lists
  3581. as described in the documentation for the `define-key' function.
  3582. The binding is probably a symbol with a function definition.
  3583.  
  3584. arguments:(keys)
  3585. Fuse-global-map
  3586. Select KEYMAP as the global keymap.
  3587.  
  3588. arguments:(keymap)
  3589. Fuse-local-map
  3590. Select KEYMAP as the local keymap.
  3591. If KEYMAP is nil, that means no local keymap.
  3592.  
  3593. arguments:(keymap)
  3594. Fcurrent-local-map
  3595. Return current buffer's local keymap, or nil if it has none.
  3596.  
  3597. arguments:()
  3598. Fcurrent-global-map
  3599. Return the current global keymap.
  3600.  
  3601. arguments:()
  3602. Fmap-keymap
  3603. Apply FUNCTION to each element of KEYMAP.  FUNCTION will be called with
  3604. two arguments: a key-description list, and the binding.  The order in which
  3605. the elements of the keymap are passed to the function is unspecified.  If
  3606. the function inserts new elements into the keymap, it may or may not
  3607. be called with them later.  No element of the keymap will ever be passed to
  3608. the function more than once.
  3609.  
  3610. The function will not be called on elements of this keymap's parent (see the
  3611. function `keymap-parent') or upon keymaps which are contained within this
  3612. keymap (multi-character definitions).  It will be called on "meta"
  3613. characters, however, since they are not really two-character sequences.
  3614.  
  3615. If the optional third argument SORT-FIRST is non-nil, then the elements of
  3616. the keymap will be passed to the mapper function in a canonical order.
  3617. Otherwise, they will be passed in hash (that is, random) order, which is
  3618. faster.
  3619.  
  3620. arguments:(function keymap &optional sort_first)
  3621. Faccessible-keymaps
  3622. Find all keymaps accessible via prefix characters from KEYMAP.
  3623. Returns a list of elements of the form (KEYS . MAP), where the sequence
  3624. KEYS starting from KEYMAP gets you to MAP.  These elements are ordered
  3625. so that the KEYS increase in length.  The first element is ([] . KEYMAP).
  3626.  
  3627. arguments:(startmap)
  3628. Fkey-description
  3629. Return a pretty description of key-sequence KEYS.
  3630. Control characters turn into "C-foo" sequences, meta into "M-foo"
  3631. spaces are put between sequence elements, etc.
  3632.  
  3633. arguments:(keys)
  3634. Fsingle-key-description
  3635. Return a pretty description of command character KEY.
  3636. Control characters turn into C-whatever, etc.
  3637.  
  3638. arguments:(key)
  3639. Ftext-char-description
  3640. Return a pretty description of file-character CHAR.
  3641. Control characters turn into "^char", etc.
  3642.  
  3643. arguments:(chr)
  3644. Fwhere-is-internal
  3645. Return list of keys that invoke DEFINITION in optional 2nd argument KEYMAP
  3646. or optional 4th argument GLOBAL_KEYMAP.
  3647. If KEYMAP is nil, search only GLOBAL_KEYMAP.
  3648. If GLOBAL_KEYMAP is nil, use the current global map.
  3649.  
  3650. If optional 3rd arg FIRSTONLY is non-nil,
  3651. return the first key sequence found, rather than a list of all possible
  3652. key sequences.
  3653.  
  3654. arguments:(definition &optional local_keymap firstonly global_keymap noindirect)
  3655. Fdescribe-bindings
  3656. Show a list of all defined keys, and their definitions.
  3657. The list is put in a buffer, which is displayed.
  3658. If the argument is non-null, then only the mouse bindings are displayed.
  3659.  
  3660. arguments:(&optional mice_only_p)
  3661. Fapropos-internal
  3662. Show all symbols whose names contain match for REGEXP.
  3663. If optional 2nd arg PRED is non-nil, (funcall PRED SYM) is done
  3664. for each symbol and a symbol is mentioned only if that returns non-nil.
  3665. Return list of symbols found.
  3666.  
  3667. arguments:(string &optional pred)
  3668. Vmeta-prefix-char
  3669. Meta-prefix character code.  Must be an ASCII integer.
  3670. This character followed by some character `foo' turns into `Meta-foo'.
  3671. To disable the meta-prefix-char, set it to a negative number.Vkeymap-tick
  3672. Incremented for each change to any keymap.Fread-char
  3673.  
  3674.  
  3675. arguments:()
  3676. Fget-file-char
  3677. Don't use this yourself.
  3678.  
  3679. arguments:()
  3680. Fload
  3681. Execute a file of Lisp code named FILE.
  3682. First try FILE with `.elc' appended, then try with `.el',
  3683.  then try FILE unmodified.
  3684. This function searches the directories in `load-path'.
  3685. If optional second arg MISSING-OK is non-nil,
  3686.  report no error if FILE doesn't exist.
  3687. Print messages at start and end of loading unless
  3688.  optional third arg NOMESSAGE is non-nil.
  3689. If optional fourth arg NOSUFFIX is non-nil, don't try adding
  3690.  suffixes `.elc' or `.el' to the specified name FILE.
  3691. Return t if file exists.
  3692.  
  3693. arguments:(str &optional missing_ok nomessage nosuffix)
  3694. Flocate-file
  3695. Search for FILENAME through PATH-LIST, expanded by one of the optional
  3696. SUFFIXES (string of suffixes separated by ":"s), checking for access
  3697. MODE (0|1|2|4 = exists|executable|writeable|readable), default readable.
  3698.  
  3699. arguments:(file path &optional suff mode)
  3700. Feval-buffer
  3701. Execute BUFFER as Lisp code.
  3702. Programs can pass argument PRINTFLAG which controls printing of output:
  3703. nil means discard it; anything else is stream for print.
  3704.  
  3705. arguments:(bufname &optional printflag)
  3706. Feval-region
  3707. Execute the region as Lisp code.
  3708. When called from programs, expects two arguments,
  3709. giving starting and ending indices in the current buffer
  3710. of the text to be executed.
  3711. Programs can pass third argument PRINTFLAG which controls output:
  3712. nil means discard it; anything else is stream for printing it.
  3713.  
  3714. If there is no error, point does not move.  If there is an error,
  3715. point remains at the end of the last character read from the buffer.
  3716.  
  3717. arguments:(b e &optional printflag)
  3718. Fread
  3719. Read one Lisp expression as text from STREAM, return as Lisp object.
  3720. If STREAM is nil, use the value of `standard-input' (which see).
  3721. STREAM or the value of `standard-input' may be:
  3722.  a buffer (read from point and advance it)
  3723.  a marker (read from where it points and advance it)
  3724.  a function (call it with no arguments for each character,
  3725.      call it with a char as argument to push a char back)
  3726.  a string (takes text from string, starting at the beginning)
  3727.  t (read text line using minibuffer and use it).
  3728.  
  3729. arguments:(&optional readcharfun)
  3730. Fread-from-string
  3731. Read one Lisp expression which is represented as text by STRING.
  3732. Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
  3733. START and END optionally delimit a substring of STRING from which to read;
  3734.  they default to 0 and (length STRING) respectively.
  3735.  
  3736. arguments:(string &optional start end)
  3737. Fintern
  3738. Return the canonical symbol whose name is STRING.
  3739. If there is none, one is created by this function and returned.
  3740. A second optional argument specifies the obarray to use;
  3741. it defaults to the value of `obarray'.
  3742.  
  3743. arguments:(str &optional obarray)
  3744. Fintern-soft
  3745. Return the canonical symbol whose name is STRING, or nil if none exists.
  3746. A second optional argument specifies the obarray to use;
  3747. it defaults to the value of `obarray'.
  3748.  
  3749. arguments:(str &optional obarray)
  3750. Fmapatoms
  3751. Call FUNCTION on every symbol in OBARRAY.
  3752. OBARRAY defaults to the value of `obarray'.
  3753.  
  3754. arguments:(function &optional obarray)
  3755. Vobarray
  3756. Symbol table for use by `intern' and `read'.
  3757. It is a vector whose length ought to be prime for best results.
  3758. The vector's contents don't make sense if examined from Lisp programs;
  3759. to find all the symbols in an obarray, use `mapatoms'.Vvalues
  3760. List of values of all expressions which were read, evaluated and printed.
  3761. Order is reverse chronological.Vstandard-input
  3762. Stream for read to get input from.
  3763. See documentation of `read' for possible values.Vload-path
  3764. *List of directories to search for files to load.
  3765. Each element is a string (directory name) or nil (try default directory).
  3766.  
  3767. Note that the elements of this list *may not* begin with "~", so you must
  3768. call `expand-file-name' on them before adding them to this list.
  3769.  
  3770. Initialized based on EMACSLOADPATH environment variable, if any,
  3771. otherwise to default specified in by file `paths.h' when Emacs was built.
  3772. If there were no paths specified in `paths.h', then emacs chooses a default
  3773. value for this variable by looking around in the file-system near the
  3774. directory in which the emacs executable resides.Vload-in-progress
  3775. Non-nil iff inside of `load'.Vafter-load-alist
  3776. An alist of expressions to be evalled when particular files are loaded.
  3777. Each element looks like (FILENAME FORMS...).
  3778. When `load' is run and the file-name argument is FILENAME,
  3779. the FORMS in the corresponding element are executed at the end of loading.
  3780.  
  3781. FILENAME must match exactly!  Normally FILENAME is the name of a library,
  3782. with no directory specified, since that is how `load' is normally called.
  3783. An error in FORMS does not undo the load,
  3784. but does prevent execution of the rest of the FORMS.Vload-warn-when-source-newer
  3785. *Whether `load' should check whether the source is newer than the binary;
  3786. If this variable is true, then when a `.elc' file is being loaded and the
  3787. corresponding `.el' is newer, a warning message will be printed.Vload-warn-when-source-only
  3788. *Whether `load' should warn when loading a .el file instead of an .elc.
  3789. If this variable is true, then when load is called with a filename without
  3790. an extension, and the .elc version doesn't exist but the .el version does,
  3791. then a message will be printed.  If an explicit extension is passed to load,
  3792. no warning will be printed.Fstart-kbd-macro
  3793. Record subsequent keyboard and menu input, defining a keyboard macro.
  3794. The commands are recorded even as they are executed.
  3795. Use \[end-kbd-macro] to finish recording and make the macro available.
  3796. Use \[name-last-kbd-macro] to give it a permanent name.
  3797. Non-nil arg (prefix arg) means append to last macro defined;
  3798.  This begins by re-executing that macro as if you typed it again.
  3799.  
  3800. arguments:(append)
  3801. Fend-kbd-macro
  3802. Finish defining a keyboard macro.
  3803. The definition was started by \[start-kbd-macro].
  3804. The macro is now available for use via \[call-last-kbd-macro],
  3805. or it can be given a name with \[name-last-kbd-macro] and then invoked
  3806. under that name.
  3807.  
  3808. With numeric arg, repeat macro now that many times,
  3809. counting the definition just completed as the first repetition.
  3810. An argument of zero means repeat until error.
  3811.  
  3812. arguments:(&optional arg)
  3813. Fcall-last-kbd-macro
  3814. Call the last keyboard macro that you defined with \[start-kbd-macro].
  3815.  
  3816. A prefix argument serves as a repeat count.  Zero means repeat until error.
  3817.  
  3818. To make a macro permanent so you can call it even after
  3819. defining others, use \[name-last-kbd-macro].
  3820.  
  3821. arguments:(&optional prefix)
  3822. Fexecute-kbd-macro
  3823. Execute MACRO as string of editor command characters.
  3824. If MACRO is a symbol, its function definition is used.
  3825. COUNT is a repeat count, or nil for once, or 0 for infinite loop.
  3826.  
  3827. arguments:(macro &optional prefixarg)
  3828. Vdefining-kbd-macro
  3829. Non-nil while a keyboard macro is being defined.  Don't set this!Vexecuting-macro
  3830. Currently executing keyboard macro (a vector of events);
  3831. nil if none executing.Vexecuting-kbd-macro
  3832. Currently executing keyboard macro (a vector of events);
  3833. nil if none executing.Vlast-kbd-macro
  3834. Last kbd macro defined, as a vector of events; nil if none defined.Fmarker-buffer
  3835. Return the buffer that MARKER points into, or nil if none.
  3836. Returns nil if MARKER points into a dead buffer.
  3837.  
  3838. arguments:(marker)
  3839. Fmarker-position
  3840. Return the position MARKER points at, as a character number.
  3841.  
  3842. arguments:(marker)
  3843. Fset-marker
  3844. Position MARKER before character number NUMBER in BUFFER.
  3845. BUFFER defaults to the current buffer.
  3846. If NUMBER is nil, makes marker point nowhere.
  3847. Then it no longer slows down editing in any buffer.
  3848. If this marker was returned by (point-marker t), then changing its position
  3849. moves point.  You cannot change its buffer or make it point nowhere.
  3850. Returns MARKER.
  3851.  
  3852. arguments:(marker pos &optional buffer)
  3853. Fcopy-marker
  3854. Return a new marker pointing at the same place as MARKER.
  3855. If argument is a number, makes a new marker pointing
  3856. at that position in the current buffer.
  3857.  
  3858. arguments:(marker)
  3859. Fset-menubar-dirty-flag
  3860. Tells emacs that the menubar widget has to be updated
  3861.  
  3862. arguments:()
  3863. Fpopup-menu
  3864. Pop up the given menu.
  3865. A menu description is a list of menu items, strings, and submenus.
  3866.  
  3867. The first element of a menu must be a string, which is the name of the
  3868. menu.  This is the string that will be displayed in the parent menu, if
  3869. any.  For toplevel menus, it is ignored.  This string is not displayed
  3870. in the menu itself.
  3871.  
  3872. A menu item is a vector of three or four elements:
  3873.  
  3874.  - the name of the menu item (a string);
  3875.  - the `callback' of that item;
  3876.  - whether this item is active (selectable);
  3877.  - and an optional string to append to the name.
  3878.  
  3879. If the `callback' of a menu item is a symbol, then it must name a command.
  3880. It will be invoked with `call-interactively'.  If it is a list, then it is
  3881. evaluated with `eval'.
  3882.  
  3883. The fourth element of a menu item is a convenient way of adding the name
  3884. of a command's ``argument'' to the menu, like ``Kill Buffer NAME''.
  3885.  
  3886. If an element of a menu is a string, then that string will be presented in
  3887. the menu as unselectable text.
  3888.  
  3889. If an element of a menu is a string consisting solely of hyphens, then that
  3890. item will be presented as a solid horizontal line.
  3891.  
  3892. If an element of a menu is a list, it is treated as a submenu.  The name of
  3893. that submenu (the first element in the list) will be used as the name of the
  3894. item representing this menu on the parent.
  3895.  
  3896. The syntax, more precisely:
  3897.  
  3898.    form        :=  <something to pass to `eval'>
  3899.    command    :=  <a symbol or string, to pass to `call-interactively'>
  3900.    callback     :=  command | form
  3901.    active-p    :=  <t or nil, whether this thing is selectable>
  3902.    text        :=  <string, non selectable>
  3903.    name        :=  <string>
  3904.    argument    :=  <string>
  3905.    menu-item    :=  '['  name callback active-p [ argument ]  ']'
  3906.    menu        :=  '(' name [ menu-item | menu | text ]+ ')'
  3907.  
  3908. arguments:(menu_desc)
  3909. Fpopup-menu-up-p
  3910. Returns T if a popup menu is up, NIL otherwise.
  3911. See popup-menu.
  3912.  
  3913. arguments:()
  3914. Fpopup-dialog-box
  3915. Pop up a dialog box.
  3916. A dialog box description is a list.
  3917.  
  3918.  - The first element of the list is a string to display in the dialog box.
  3919.  - The rest of the elements are descriptions of the dialog box's buttons.
  3920.    Each one is a vector of three elements:
  3921.    - The first element is the text of the button.
  3922.    - The second element is the `callback'.
  3923.    - The third element is t or nil, whether this button is selectable.
  3924.  
  3925. If the `callback' of a button is a symbol, then it must name a command.
  3926. It will be invoked with `call-interactively'.  If it is a list, then it is
  3927. evaluated with `eval'.
  3928.  
  3929. One (and only one) of the buttons may be `nil'.  This marker means that all
  3930. following buttons should be flushright instead of flushleft.
  3931.  
  3932. The syntax, more precisely:
  3933.  
  3934.    form        :=  <something to pass to `eval'>
  3935.    command    :=  <a symbol or string, to pass to `call-interactively'>
  3936.    callback     :=  command | form
  3937.    active-p    :=  <t or nil, whether this thing is selectable>
  3938.    name        :=  <string>
  3939.    partition    :=  'nil'
  3940.    button    :=  '['  name callback active-p ']'
  3941.    dialog    :=  '(' name [ button ]+ [ partition [ button ]+ ] ')'
  3942.  
  3943. arguments:(dbox_desc)
  3944. Vcurrent-menubar
  3945. The current menubar.  This may be buffer-local.
  3946.  
  3947. When the menubar is changed, the function `set-menubar-dirty-flag' has to
  3948. be called for the menubar to be updated on the screen.  See `set-menubar'
  3949. and `set-buffer-menubar'.
  3950.  
  3951. A menubar is a list of menus and menu-items.
  3952. A menu is a list of menu items, strings, and submenus.
  3953.  
  3954. The first element of a menu must be a string, which is the name of the
  3955. menu.  This is the string that will be displayed in the menubar, or in
  3956. the parent menu.  This string is not displayed in the menu itself.
  3957.  
  3958. A menu item is a vector of three or four elements:
  3959.  
  3960.  - the name of the menu item (a string);
  3961.  - the `callback' of that item;
  3962.  - whether this item is active (selectable);
  3963.  - and an optional string to append to the name.
  3964.  
  3965. If the `callback' of a menu item is a symbol, then it must name a command.
  3966. It will be invoked with `call-interactively'.  If it is a list, then it is
  3967. evaluated with `eval'.
  3968.  
  3969. The fourth element of a menu item is a convenient way of adding the name
  3970. of a command's ``argument'' to the menu, like ``Kill Buffer NAME''.
  3971.  
  3972. If an element of a menu (or menubar) is a string, then that string will be
  3973. presented in the menu (or menubar) as unselectable text.
  3974.  
  3975. If an element of a menu is a string consisting solely of hyphens, then that
  3976. item will be presented as a solid horizontal line.
  3977.  
  3978. If an element of a menu is a list, it is treated as a submenu.  The name of
  3979. that submenu (the first element in the list) will be used as the name of
  3980. the item representing this menu on the parent.
  3981.  
  3982. If an element of a menubar is `nil', then it is used to represent the
  3983. division between the set of menubar-items which are flushleft and those
  3984. which are flushright.  (Note: this isn't completely implemented yet.)
  3985.  
  3986. After the menubar is clicked upon, but before any menus are popped up,
  3987. the functions on the `activate-menubar-hook' are invoked to make changes
  3988. to the menus and menubar.  This is intended to implement lazy alteration
  3989. of the sensitivity of menu items.
  3990.  
  3991. The syntax, more precisely:
  3992.  
  3993.    form        :=  <something to pass to `eval'>
  3994.    command    :=  <a symbol or string, to pass to `call-interactively'>
  3995.    callback     :=  command | form
  3996.    active-p    :=  <t or nil, whether this thing is selectable>
  3997.    text        :=  <string, non selectable>
  3998.    name        :=  <string>
  3999.    argument    :=  <string>
  4000.    menu-item    :=  '['  name callback active-p [ argument ]  ']'
  4001.    menu        :=  '(' name [ menu-item | menu | text ]+ ')'
  4002.    partition    :=  'nil'
  4003.    menubar    :=  '(' [ menu-item | menu | text ]* [ partition ]
  4004.                 [ menu-item | menu | text ]*
  4005.              ')'Vactivate-menubar-hook
  4006. Function or functions called before a menubar menu is pulled down.
  4007. These functions are called with no arguments, and should interrogate and
  4008. modify the value of `current-menubar' as desired.
  4009.  
  4010. The functions on this hook are invoked after the mouse goes down, but before
  4011. the menu is mapped, and may be used to activate, deactivate, add, or delete
  4012. items from the menus.
  4013.  
  4014. These functions may return the symbol `t' to assert that they have made
  4015. no changes to the menubar.  If any other value is returned, the menubar is
  4016. recomputed.  If `t' is returned but the menubar has been changed, then the
  4017. changes may not show up right away.  Returning `nil' when the menubar has
  4018. not changed is not so bad; more computation will be done, but redisplay of
  4019. the menubar will still be performed optimally.Vmenu-no-selection-hook
  4020. Function or functions to call when a menu or dialog box is dismissed
  4021. without a selecting having been made.Vmenubar-show-keybindings
  4022. If true, the menubar will display keyboard equivalents.
  4023. If false, only the command names will be displayed.Fminibuffer-depth
  4024. Return current depth of activations of minibuffer, a nonnegative integer.
  4025.  
  4026. arguments:()
  4027. Fread-minibuffer-internal
  4028. Lowest-level interface to minibuffers.  Don't call this.
  4029.  
  4030. arguments:(prompt)
  4031. Ftry-completion
  4032. Return common substring of all completions of STRING in ALIST.
  4033. Each car of each element of ALIST is tested to see if it begins with STRING.
  4034. All that match are compared together; the longest initial sequence
  4035. common to all matches is returned as a string.
  4036. If there is no match at all, nil is returned.
  4037. For an exact match, t is returned.
  4038.  
  4039. ALIST can be an obarray instead of an alist.
  4040. Then the print names of all symbols in the obarray are the possible matches.
  4041.  
  4042. ALIST can also be a function to do the completion itself.
  4043. It receives three arguments: the values STRING, PREDICATE and nil.
  4044. Whatever it returns becomes the value of `try-completion'.
  4045.  
  4046. If optional third argument PREDICATE is non-nil,
  4047. it is used to test each possible match.
  4048. The match is a candidate only if PREDICATE returns non-nil.
  4049. The argument given to PREDICATE is the alist element or the symbol from the obarray.
  4050.  
  4051. arguments:(string alist &optional pred)
  4052. Fall-completions
  4053. Search for partial matches to STRING in ALIST.
  4054. Each car of each element of ALIST is tested to see if it begins with STRING.
  4055. The value is a list of all the strings from ALIST that match.
  4056. ALIST can be an obarray instead of an alist.
  4057. Then the print names of all symbols in the obarray are the possible matches.
  4058.  
  4059. ALIST can also be a function to do the completion itself.
  4060. It receives three arguments: the values STRING, PREDICATE and t.
  4061. Whatever it returns becomes the value of `all-completions'.
  4062.  
  4063. If optional third argument PREDICATE is non-nil,
  4064. it is used to test each possible match.
  4065. The match is a candidate only if PREDICATE returns non-nil.
  4066. The argument given to PREDICATE is the alist element or
  4067. the symbol from the obarray.
  4068.  
  4069. arguments:(string alist &optional pred)
  4070. Vcompletion-ignore-case
  4071. Non-nil means don't consider case significant in completion.Fml-if
  4072. Mocklisp version of `if'.
  4073.  
  4074. arguments: (&rest args)
  4075. Fml-nargs
  4076. Number of arguments to currently executing mocklisp function.
  4077.  
  4078. arguments:()
  4079. Fml-arg
  4080. Argument number N to currently executing mocklisp function.
  4081.  
  4082. arguments:(n &optional prompt)
  4083. Fml-interactive
  4084. True if currently executing mocklisp function was called interactively.
  4085.  
  4086. arguments:()
  4087. Fml-provide-prefix-argument
  4088. Evaluate second argument, using first argument as prefix arg value.
  4089.  
  4090. arguments: (arg1 arg2 &rest args)
  4091. Fml-prefix-argument-loop
  4092.  
  4093.  
  4094. arguments: (&rest args)
  4095. Fml-substr
  4096. Return a substring of STRING, starting at index FROM and of length LENGTH.
  4097. If either FROM or LENGTH is negative, the length of STRING is added to it.
  4098.  
  4099. arguments:(string from to)
  4100. Finsert-string
  4101. Mocklisp-compatibility insert function.
  4102. Like the function `insert' except that any argument that is a number
  4103. is converted into a string by expressing it in decimal.
  4104.  
  4105. arguments: (&rest args)
  4106. Fwrite-char
  4107. Output character CHAR to stream STREAM.
  4108. STREAM defaults to the value of `standard-output' (which see).
  4109.  
  4110. arguments:(ch &optional printcharfun)
  4111. Fwith-output-to-temp-buffer
  4112. Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
  4113. The buffer is cleared out initially, and marked as unmodified when done.
  4114. All output done by BODY is inserted in that buffer by default.
  4115. The buffer is displayed in another window, but not selected.
  4116. The value of the last form in BODY is returned.
  4117. If BODY does not finish normally, the buffer BUFNAME is not displayed.
  4118.  
  4119. If variable `temp-buffer-show-function' is non-nil, call it at the end
  4120. to get the buffer displayed.  It gets one argument, the buffer to display.
  4121.  
  4122. arguments: (arg1 &rest args)
  4123. Fterpri
  4124. Output a newline to STREAM.
  4125. If STREAM is omitted or nil, the value of `standard-output' is used.
  4126.  
  4127. arguments:(&optional printcharfun)
  4128. Fprin1
  4129. Output the printed representation of OBJECT, any Lisp object.
  4130. Quoting characters are printed when needed to make output that `read'
  4131. can handle, whenever this is possible.
  4132. Output stream is STREAM, or value of `standard-output' (which see).
  4133.  
  4134. arguments:(obj &optional printcharfun)
  4135. Fprin1-to-string
  4136. Return a string containing the printed representation of OBJECT,
  4137. any Lisp object.  Quoting characters are used when needed to make output
  4138. that `read' can handle, whenever this is possible, unless the optional
  4139. second argument NOESCAPE is non-nil.
  4140.  
  4141. arguments:(obj &optional noescape)
  4142. Fprinc
  4143. Output the printed representation of OBJECT, any Lisp object.
  4144. No quoting characters are used; no delimiters are printed around
  4145. the contents of strings.
  4146. Output stream is STREAM, or value of standard-output (which see).
  4147.  
  4148. arguments:(obj &optional printcharfun)
  4149. Fprint
  4150. Output the printed representation of OBJECT, with newlines around it.
  4151. Quoting characters are printed when needed to make output that `read'
  4152. can handle, whenever this is possible.
  4153. Output stream is STREAM, or value of `standard-output' (which see).
  4154.  
  4155. arguments:(obj &optional printcharfun)
  4156. Falternate-debugging-output
  4157. Append CHARACTER to a string.
  4158. You can call print while debugging emacs, and pass it this function
  4159. to make it write to the debugging output.
  4160.  
  4161.  
  4162. arguments:(character)
  4163. Fexternal-debugging-output
  4164. Write CHARACTER to stderr.
  4165. You can call print while debugging emacs, and pass it this function
  4166. to make it write to the debugging output.
  4167.  
  4168.  
  4169. arguments:(character)
  4170. Vstandard-output
  4171. Output stream `print' uses by default for outputting a character.
  4172. This may be any function of one argument.
  4173. It may also be a buffer (output is inserted before point)
  4174. or a marker (output is inserted and the marker is advanced)
  4175. or the symbol t (output appears in the minibuffer line).Vfloat-output-format
  4176. The format descriptor string that lisp uses to print floats.
  4177. This is a %-spec like those accepted by `printf' in C,
  4178. but with some restrictions.  It must start with the two characters `%.'.
  4179. After that comes an integer precision specification,
  4180. and then a letter which controls the format.
  4181. The letters allowed are `e', `f' and `g'.
  4182. Use `e' for exponential notation "DIG.DIGITSeEXPT"
  4183. Use `f' for decimal point notation "DIGITS.DIGITS".
  4184. Use `g' to choose the shorter of those two formats for the number at hand.
  4185. The precision in any of these cases is the number of digits following
  4186. the decimal point.  With `f', a precision of 0 means to omit the
  4187. decimal point.  0 is not allowed with `f' or `g'.
  4188.  
  4189. A value of nil means to use `%.16g'.
  4190.  
  4191. Regardless of the value of `float-output-format', a floating point number
  4192. will never be printed in such a way that it is ambiguous with an integer;
  4193. that is, a floating-point number will always be printed with a decimal
  4194. point and/or an exponent, even if the digits following the decimal point
  4195. are all zero.  This is to preserve read-equivalence.Vprint-length
  4196. Maximum length of list to print before abbreviating.A value of nil means no limit.Vprint-level
  4197. Maximum depth of list nesting to print before abbreviating.A value of nil means no limit.Vprint-escape-newlines
  4198. Non-nil means print newlines in strings as backslash-n.Vprint-readably
  4199. If non-nil, then all objects will be printed in a readable form.
  4200. If an object has no readable representation, then an error is signalled.
  4201. When this is true, compiled-function objects will be written in #[...] form
  4202. instead of in #<byte-code [...]> form.
  4203. Do not SET this variable; bind it instead.Vprint-gensym
  4204. If non-nil, then uninterned symbols (those made with `make-symbol'
  4205. instead of `intern') will be preceeded by "#:", which tells the reader to
  4206. create a new symbol instead of interning.  Beware: the #: syntax creates a
  4207. new symbol each time it is seen, so if you print an object which contains
  4208. two pointers to the same uninterned symbol, `read' will not duplicate that
  4209. structure.Fprocessp
  4210. Return t if OBJECT is a process.
  4211.  
  4212. arguments:(obj)
  4213. Fget-process
  4214. Return the process named NAME, or nil if there is none.
  4215.  
  4216. arguments:(name)
  4217. Fget-buffer-process
  4218. Return the (or, a) process associated with BUFFER.
  4219. BUFFER may be a buffer or the name of one.
  4220.  
  4221. arguments:(name)
  4222. Fdelete-process
  4223. Delete PROCESS: kill it and forget about it immediately.
  4224. PROCESS may be a process or the name of one, or a buffer name.
  4225.  
  4226. arguments:(proc)
  4227. Fprocess-status
  4228. Return the status of PROCESS: a symbol, one of these:
  4229. run  -- for a process that is running.
  4230. stop -- for a process stopped but continuable.
  4231. exit -- for a process that has exited.
  4232. signal -- for a process that has got a fatal signal.
  4233. open -- for a network stream connection that is open.
  4234. closed -- for a network stream connection that is closed.
  4235. nil -- if arg is a process name and no such process exists.
  4236.  
  4237. arguments:(proc)
  4238. Fprocess-exit-status
  4239. Return the exit status of PROCESS or the signal number that killed it.
  4240. If PROCESS has not yet exited or died, return 0.
  4241. If PROCESS is a net connection that was closed remotely, return 256.
  4242.  
  4243. arguments:(proc)
  4244. Fprocess-id
  4245. Return the process id of PROCESS.
  4246. This is the pid of the Unix process which PROCESS uses or talks to.
  4247. For a network connection, this value is nil.
  4248.  
  4249. arguments:(proc)
  4250. Fprocess-name
  4251. Return the name of PROCESS, as a string.
  4252. This is the name of the program invoked in PROCESS,
  4253. possibly modified to make it unique among process names.
  4254.  
  4255. arguments:(proc)
  4256. Fprocess-command
  4257. Return the command that was executed to start PROCESS.
  4258. This is a list of strings, the first string being the program executed
  4259. and the rest of the strings being the arguments given to it.
  4260. For a non-child channel, this is nil.
  4261.  
  4262. arguments:(proc)
  4263. Fset-process-buffer
  4264. Set buffer associated with PROCESS to BUFFER (a buffer, or nil).
  4265.  
  4266. arguments:(proc buffer)
  4267. Fprocess-buffer
  4268. Return the buffer PROCESS is associated with.
  4269. Output from PROCESS is inserted in this buffer
  4270. unless PROCESS has a filter.
  4271.  
  4272. arguments:(proc)
  4273. Fprocess-mark
  4274. Return the marker for the end of the last output from PROCESS.
  4275.  
  4276. arguments:(proc)
  4277. Fset-process-filter
  4278. Give PROCESS the filter function FILTER; nil means no filter.
  4279. When a process has a filter, each time it does output
  4280. the entire string of output is passed to the filter.
  4281. The filter gets two arguments: the process and the string of output.
  4282. If the process has a filter, its buffer is not used for output.
  4283.  
  4284. arguments:(proc filter)
  4285. Fprocess-filter
  4286. Returns the filter function of PROCESS; nil if none.
  4287. See `set-process-filter' for more info on filter functions.
  4288.  
  4289. arguments:(proc)
  4290. Fset-process-sentinel
  4291. Give PROCESS the sentinel SENTINEL; nil for none.
  4292. The sentinel is called as a function when the process changes state.
  4293. It gets two arguments: the process, and a string describing the change.
  4294.  
  4295. arguments:(proc sentinel)
  4296. Fprocess-sentinel
  4297. Return the sentinel of PROCESS; nil if none.
  4298. See `set-process-sentinel' for more info on sentinels.
  4299.  
  4300. arguments:(proc)
  4301. Fprocess-kill-without-query
  4302. Say no query needed if PROCESS is running when Emacs is exited.
  4303. Optional second argument if non-nil says to require a query.
  4304. Value is t if a query was formerly required.
  4305.  
  4306. arguments:(proc &optional value)
  4307. Fprocess-kill-without-query-p
  4308. Return t or nil, depending on whether or not PROCESS will be killed
  4309. without query.
  4310.  
  4311. arguments:(proc)
  4312. Flist-processes
  4313. Display a list of all processes.
  4314. (Any processes listed as Exited or Signaled are actually eliminated
  4315. after the listing is made.)
  4316.  
  4317. arguments:()
  4318. Fprocess-list
  4319. Return a list of all processes.
  4320.  
  4321. arguments:()
  4322. Fstart-process
  4323. Start a program in a subprocess.  Return the process object for it.
  4324. Args are NAME BUFFER PROGRAM &rest PROGRAM-ARGS
  4325. NAME is name for process.  It is modified if necessary to make it unique.
  4326. BUFFER is the buffer or (buffer-name) to associate with the process.
  4327.  Process output goes at end of that buffer, unless you specify
  4328.  an output stream or filter function to handle the output.
  4329.  BUFFER may be also nil, meaning that this process is not associated
  4330.  with any buffer
  4331. Third arg is program file name.  It is searched for as in the shell.
  4332. Remaining arguments are strings to give program as arguments.
  4333.  
  4334. arguments: (arg1 arg2 arg3 &rest args)
  4335. Fopen-network-stream
  4336. Open a TCP connection for a service to a host.
  4337. Returns a subprocess-object to represent the connection.
  4338. Input and output work as for subprocesses; `delete-process' closes it.
  4339. Args are NAME BUFFER HOST SERVICE.
  4340. NAME is name for process.  It is modified if necessary to make it unique.
  4341. BUFFER is the buffer (or buffer-name) to associate with the process.
  4342.  Process output goes at end of that buffer, unless you specify
  4343.  an output stream or filter function to handle the output.
  4344.  BUFFER may be also nil, meaning that this process is not associated
  4345.  with any buffer
  4346. Third arg is name of the host to connect to.
  4347. Fourth arg SERVICE is name of the service desired, or an integer
  4348.  specifying a port number to connect to.
  4349.  
  4350. arguments:(name buffer host service)
  4351. Fwaiting-for-user-input-p
  4352. Returns non-NIL if emacs is waiting for input from the user.
  4353. This is intended for use by asynchronous process output filters and sentinels.
  4354.  
  4355. arguments:()
  4356. Fprocess-send-region
  4357. Send current contents of region as input to PROCESS.
  4358. PROCESS may be a process name or an actual process.
  4359. Called from program, takes three arguments, PROCESS, START and END.
  4360. If the region is more than 500 characters long,
  4361. it is sent in several bunches.  This may happen even for shorter regions.
  4362. Output from processes can arrive in between bunches.
  4363.  
  4364. arguments:(process start end)
  4365. Fprocess-send-string
  4366. Send PROCESS the contents of STRING as input.
  4367. PROCESS may be a process name or an actual process.
  4368. If STRING is more than 500 characters long,
  4369. it is sent in several bunches.  This may happen even for shorter strings.
  4370. Output from processes can arrive in between bunches.
  4371.  
  4372. arguments:(process string)
  4373. Finterrupt-process
  4374. Interrupt process PROCESS.  May be process or name of one.
  4375. Nil or no arg means current buffer's process.
  4376. Second arg CURRENT-GROUP non-nil means send signal to
  4377. the current process-group of the process's controlling terminal
  4378. rather than to the process's own process group.
  4379. If the process is a shell, this means interrupt current subjob
  4380. rather than the shell.
  4381.  
  4382. arguments:(&optional process current_group)
  4383. Fkill-process
  4384. Kill process PROCESS.  May be process or name of one.
  4385. See function `interrupt-process' for more details on usage.
  4386.  
  4387. arguments:(&optional process current_group)
  4388. Fquit-process
  4389. Send QUIT signal to process PROCESS.  May be process or name of one.
  4390. See function `interrupt-process' for more details on usage.
  4391.  
  4392. arguments:(&optional process current_group)
  4393. Fstop-process
  4394. Stop process PROCESS.  May be process or name of one.
  4395. See function `interrupt-process' for more details on usage.
  4396.  
  4397. arguments:(&optional process current_group)
  4398. Fcontinue-process
  4399. Continue process PROCESS.  May be process or name of one.
  4400. See function `interrupt-process' for more details on usage.
  4401.  
  4402. arguments:(&optional process current_group)
  4403. Fsignal-process
  4404. Send the process with number PID the signal with code CODE.
  4405. Both PID and CODE are integers.
  4406.  
  4407. arguments:(pid sig)
  4408. Fprocess-send-eof
  4409. Make PROCESS see end-of-file in its input.
  4410. Eof comes after any text already sent to it.
  4411. nil or no arg means current buffer's process.
  4412.  
  4413. arguments:(&optional process)
  4414. Fprocess-connection
  4415. Return the connection type of `PROCESS'.  This can be nil (pipe),
  4416. t or pty (pty) or stream (socket connection).
  4417.  
  4418. arguments:(&optional process)
  4419. Vdelete-exited-processes
  4420. *Non-nil means delete processes immediately when they exit.
  4421. nil means don't delete them until `list-processes' is run.Vprocess-connection-type
  4422. Control type of device used to communicate with subprocesses.
  4423. Values are nil to use a pipe, and t or 'pty for a pty.  Note that if
  4424. pty's are not available, this variable will be ignored. The value takes
  4425. effect when `start-process' is called.Fscreenp
  4426. Return non-nil if OBJECT is a screen.
  4427. Value is t for a termcap screen (a character-only terminal),
  4428. `x' for an Emacs screen that is really an X window.
  4429.  
  4430. arguments:(screen)
  4431. Fselect-screen
  4432. Select the screen S.
  4433. S's selected window becomes the selected window.
  4434.  
  4435. arguments:(screen)
  4436. Fselected-screen
  4437. Return the screen that is now selected.
  4438.  
  4439. arguments:()
  4440. Fwindow-screen
  4441. Return the screen that window WINDOW is on.
  4442.  
  4443. arguments:(window)
  4444. Fscreen-root-window
  4445. Returns the root-window of SCREEN.
  4446.  
  4447. arguments:(&optional screen)
  4448. Fscreen-selected-window
  4449. Return the selected window of screen SCREEN.
  4450.  
  4451. arguments:(&optional screen)
  4452. Fscreen-list
  4453. Return a list of all screens.
  4454.  
  4455. arguments:()
  4456. Fnext-screen
  4457. Return the next screen in the screen list after SCREEN.
  4458. If MINISCREEN is non-nil, include the global-minibuffer-screen if it
  4459. has its own screen.
  4460. If VISIBLE-ONLY-P is non-nil, then cycle through the visible screens,
  4461. instead of all screens.
  4462.  
  4463. arguments:(&optional screen miniscreen visible_only_p)
  4464. Fprevious-screen
  4465. Return the previous screen in the screen list after SCREEN.
  4466. If MINISCREEN is non-nil, include the global-minibuffer-screen if it
  4467. has its own screen.
  4468. If VISIBLE-ONLY-P is non-nil, then cycle through the visible screens,
  4469. instead of all screens.
  4470.  
  4471. arguments:(&optional screen miniscreen visible_only_p)
  4472. Fdelete-screen
  4473. Delete SCREEN, permanently eliminating it from use.
  4474. Default is current screen.
  4475.  
  4476. arguments:(&optional screen)
  4477. Fread-mouse-position
  4478. Return a cons (x . y) which represents the position of the mouse.
  4479.  
  4480. arguments:(screen)
  4481. Fset-mouse-position
  4482. Move the mouse pointer to the center of character cell (X,Y) in SCREEN.
  4483.  
  4484. arguments:(screen x y)
  4485. Fscreen-configuration
  4486. Return object describing current screen configuration.
  4487. The screen configuration is the current mouse position and selected screen.
  4488. This object can be given to `restore-screen-configuration'
  4489. to restore this screen configuration.
  4490.  
  4491. arguments:()
  4492. Frestore-screen-configuration
  4493. Restores screen configuration CONFIGURATION.
  4494.  
  4495. arguments:(config)
  4496. Fmake-screen-visible
  4497. Make the screen SCREEN visible (assuming it is an X-window).
  4498. Also raises the screen so that nothing obscures it.
  4499.  
  4500. arguments:(screen)
  4501. Fmake-screen-invisible
  4502. Unconditionally removes screen from the display (assuming it is an X-window).
  4503. If what you want to do is iconify the screen (if the window manager uses
  4504. icons) then you should call `iconify-screen' instead.
  4505.  
  4506. arguments:(screen)
  4507. Ficonify-screen
  4508. Make the screen SCREEN into an icon, if the window manager supports icons.
  4509.  
  4510. arguments:(screen)
  4511. Fdeiconify-screen
  4512. Open (de-iconify) the iconified screen SCREEN.
  4513.  
  4514. arguments:(screen)
  4515. Fscreen-visible-p
  4516. Return t if SCREEN is now "visible" (actually in use for display).
  4517. A screen that is not "visible" is not updated and, if it works through
  4518. a window system, it may not show at all.
  4519. Return the symbol `icon' if window is visible only as an icon.
  4520.  
  4521. arguments:(screen)
  4522. Fvisible-screen-list
  4523. Return a list of all screens now "visible" (being updated).
  4524.  
  4525. arguments:()
  4526. Fscreen-parameters
  4527. Return the parameters-alist of screen SCREEN.
  4528. It is a list of elements of the form (PARM . VALUE), where PARM is a symbol.
  4529. The meaningful PARMs depend on the kind of screen.
  4530.  
  4531. arguments:(&optional screen)
  4532. Fmodify-screen-parameters
  4533. Modify the parameters of screen SCREEN according to ALIST.
  4534. ALIST is an alist of parameters to change and their new values.
  4535. Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.
  4536. The meaningful PARMs depend on the kind of screen; undefined PARMs are ignored.
  4537.  
  4538. arguments:(screen alist)
  4539. Fscreen-height
  4540. Return number of lines available for display on SCREEN.
  4541.  
  4542. arguments:(&optional screen)
  4543. Fscreen-width
  4544. Return number of columns available for display on SCREEN.
  4545.  
  4546. arguments:(&optional screen)
  4547. Fscreen-name
  4548. Returns the name of SCREEN (defaulting to the selected screen).
  4549. This is not the same as the `title' of the screen.
  4550.  
  4551. arguments:(&optional screen)
  4552. Fscreen-totally-visible-p
  4553. Return T if screen is not obscured by any other X windows, NIL otherwise
  4554.  
  4555. arguments:(&optional screen)
  4556. Fset-screen-height
  4557. Specify that the screen SCREEN has LINES lines.
  4558. Optional third arg non-nil means that redisplay should use LINES lines
  4559. but that the idea of the actual height of the screen should not be changed.
  4560.  
  4561. arguments:(screen rows &optional pretend)
  4562. Fset-screen-width
  4563. Specify that the screen SCREEN has COLS columns.
  4564. Optional third arg non-nil means that redisplay should use COLS columns
  4565. but that the idea of the actual width of the screen should not be changed.
  4566.  
  4567. arguments:(screen cols &optional pretend)
  4568. Fset-screen-size
  4569. Sets size of SCREEN to COLS by ROWS.
  4570. Optional fourth arg non-nil means that redisplay should use COLS by ROWS
  4571. but that the idea oft eh acrual size of the screen should not be changed.
  4572.  
  4573. arguments:(screen cols rows &optional pretend)
  4574. Fset-screen-position
  4575. Sets position of SCREEN in pixels to XOFFSET by YOFFSET.
  4576.  
  4577. arguments:(screen xoffset yoffset)
  4578. Fraise-screen
  4579. Make the window of SCREEN be the uppermost one (fully visible).
  4580.  
  4581. arguments:(screen)
  4582. Flower-screen
  4583. Make the window of SCREEN be the bottommost one.
  4584.  
  4585. arguments:(screen)
  4586. Fcoordinates-in-window-p
  4587. Return non-nil if COORDINATES are in WINDOW.
  4588. COORDINATES is a cons of the form (X Y), X and Y being screen-relative.
  4589. If COORDINATES are in the text portion of WINDOW, the coordinates relative
  4590. to the window are returned.  If they are in the modeline of WINDOW, t is
  4591. returned.
  4592.  
  4593. arguments:(coordinates window)
  4594. Flocate-window-from-coordinates
  4595. Return window on SCREEN containing position COORDINATES.
  4596. COORDINATES is a list (SCREEN-X SCREEN-Y) of coordinates
  4597. which are relative to 0,0 at the top left corner of the screen.
  4598.  
  4599. arguments:(screen coordinates)
  4600. Vterminal-screen
  4601. The initial screen-object, which represents Emacs's stdout.Vglobal-minibuffer-screen
  4602. A screen-object holding the default minibuffer for minibufferless screens.
  4603. When you create a minibufferless screen, by default it will use the
  4604. minibuffer of this screen.  It is up to you to create a suitable screen
  4605. and store it in this variable.Vallow-deletion-of-last-visible-screen
  4606. *If nil, the last visible screen may not be deleted by `delete-window'
  4607. You can never delete the last screen, but setting this to t will allow you
  4608. to delete the last non-iconified screen.Vcreate-screen-hook
  4609. Function or functions of one argument, called with each newly-created screen.Vmouse-enter-screen-hook
  4610. Function or functions to call when mouse enters a screen.  One arg, the screen.
  4611. Be careful not to make assumptions about the window manger's focus model.
  4612. In most cases, the `deselect-screen-hook' is more appropriate.Vmouse-leave-screen-hook
  4613. Function or functions to call when mouse leaves screen.  One arg, the screen.
  4614. Be careful not to make assumptions about the window manger's focus model.
  4615. In most cases, the `select-screen-hook' is more appropriate.Vmap-screen-hook
  4616. Function or functions to call when screen is mapped.
  4617. One arg, the screen.Vunmap-screen-hook
  4618. Function or functions to call when screen is unmapped.
  4619. One arg, the screen.Vmouse-motion-handler
  4620. Handler for motion events.  One arg, the event.
  4621. For most applications, you should use `mode-motion-hook' instead of this.Vmouse-grabbed-buffer
  4622. A buffer which should be consulted first for all mouse activity.
  4623. When a mouse-clicked it processed, it will first be looked up in the
  4624. local-map of this buffer, and then through the normal mechanism if there
  4625. is no binding for that click.  This buffer's value of `mode-motion-hook'
  4626. will be consulted instead of the `mode-motion-hook' of the buffer of the
  4627. window under the mouse.  You should *bind* this, not set it.Flooking-at
  4628. t if text after point matches regular expression PAT.
  4629.  
  4630. arguments:(string)
  4631. Fstring-match
  4632. Return index of start of first match for REGEXP in STRING, or nil.
  4633. If third arg START is non-nil, start search at that index in STRING.
  4634. For index of first char beyond the match, do (match-end 0).
  4635. match-end and match-beginning also give indices of substrings
  4636. matched by parenthesis constructs in the pattern.
  4637.  
  4638. arguments:(regexp string &optional start)
  4639. Fskip-chars-forward
  4640. Move point forward, stopping before a char not in CHARS, or at position LIM.
  4641. CHARS is like the inside of a [...] in a regular expression
  4642. except that ] is never special and \ quotes ^, - or \.
  4643. Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
  4644. With arg "^a-zA-Z", skips nonletters stopping before first letter.
  4645.  
  4646. arguments:(string &optional lim)
  4647. Fskip-chars-backward
  4648. Move point backward, stopping after a char not in CHARS, or at position LIM.
  4649. See skip-chars-forward for details.
  4650.  
  4651. arguments:(string &optional lim)
  4652. Fsearch-backward
  4653. Search backward from point for STRING.
  4654. Set point to the beginning of the occurrence found, and return t.
  4655. An optional second argument bounds the search; it is a buffer position.
  4656. The match found must not extend before that position.
  4657. Optional third argument, if t, means if fail just return nil (no error).
  4658.  If not nil and not t, position at limit of search and return nil.
  4659. Optional fourth argument is repeat count--search for successive occurrences.
  4660.  
  4661. arguments:(string &optional bound noerror count)
  4662. Fsearch-forward
  4663. Search forward from point for STRING.
  4664. Set point to the end of the occurrence found, and return t.
  4665. An optional second argument bounds the search; it is a buffer position.
  4666. The match found must not extend after that position.
  4667. Optional third argument, if t, means if fail just return nil (no error).
  4668.   If not nil and not t, move to limit of search and return nil.
  4669. Optional fourth argument is repeat count--search for successive occurrences.
  4670.  
  4671. arguments:(string &optional bound noerror count)
  4672. Fword-search-backward
  4673. Search backward from point for STRING, ignoring differences in punctuation.
  4674. Set point to the beginning of the occurrence found, and return t.
  4675. An optional second argument bounds the search; it is a buffer position.
  4676. The match found must not extend before that position.
  4677. Optional third argument, if t, means if fail just return nil (no error).
  4678.   If not nil and not t, move to limit of search and return nil.
  4679. Optional fourth argument is repeat count--search for successive occurrences.
  4680.  
  4681. arguments:(string &optional bound noerror count)
  4682. Fword-search-forward
  4683. Search forward from point for STRING, ignoring differences in punctuation.
  4684. Set point to the end of the occurrence found, and return t.
  4685. An optional second argument bounds the search; it is a buffer position.
  4686. The match found must not extend after that position.
  4687. Optional third argument, if t, means if fail just return nil (no error).
  4688.   If not nil and not t, move to limit of search and return nil.
  4689. Optional fourth argument is repeat count--search for successive occurrences.
  4690.  
  4691. arguments:(string &optional bound noerror count)
  4692. Fre-search-backward
  4693. Search backward from point for match for regular expression REGEXP.
  4694. Set point to the beginning of the match, and return t.
  4695. The match found is the one starting last in the buffer
  4696. and yet ending before the place the origin of the search.
  4697. An optional second argument bounds the search; it is a buffer position.
  4698. The match found must start at or after that position.
  4699. Optional third argument, if t, means if fail just return nil (no error).
  4700.   If not nil and not t, move to limit of search and return nil.
  4701. Optional fourth argument is repeat count--search for successive occurrences.
  4702. See also the functions match-beginning and match-end and replace-match.
  4703.  
  4704. arguments:(string &optional bound noerror count)
  4705. Fre-search-forward
  4706. Search forward from point for regular expression REGEXP.
  4707. Set point to the end of the occurrence found, and return t.
  4708. An optional second argument bounds the search; it is a buffer position.
  4709. The match found must not extend after that position.
  4710. Optional third argument, if t, means if fail just return nil (no error).
  4711.   If not nil and not t, move to limit of search and return nil.
  4712. Optional fourth argument is repeat count--search for successive occurrences.
  4713. See also the functions match-beginning and match-end and replace-match.
  4714.  
  4715. arguments:(string &optional bound noerror count)
  4716. Freplace-match
  4717. Replace text matched by last search with NEWTEXT.
  4718. If second arg FIXEDCASE is non-nil, do not alter case of replacement text.
  4719. Otherwise convert to all caps or cap initials, like replaced text.
  4720. If third arg LITERAL is non-nil, insert NEWTEXT literally.
  4721. Otherwise treat \ as special:
  4722.   \& in NEWTEXT means substitute original matched text,
  4723.   \N means substitute match for \(...\) number N,
  4724.   \\ means insert one \.
  4725. Leaves point at end of replacement text.
  4726.  
  4727. arguments:(string &optional fixedcase literal)
  4728. Fmatch-beginning
  4729. Return the character number of start of text matched by last regexp searched for.
  4730. ARG, a number, specifies which parenthesized expression in the last regexp.
  4731.  Value is nil if ARGth pair didn't match, or there were less than ARG pairs.
  4732. Zero means the entire text matched by the whole regexp.
  4733.  
  4734. arguments:(num)
  4735. Fmatch-end
  4736. Return the character number of end of text matched by last regexp searched for.
  4737. ARG, a number, specifies which parenthesized expression in the last regexp.
  4738.  Value is nil if ARGth pair didn't match, or there were less than ARG pairs.
  4739. Zero means the entire text matched by the whole regexp.
  4740.  
  4741. arguments:(num)
  4742. Fmatch-data
  4743. Return list containing all info on what the last search matched.
  4744. Element 2N is (match-beginning N); element 2N + 1 is (match-end N).
  4745. All the elements are normally markers, or nil if the Nth pair didn't match.
  4746. 0 is also possible, when matching was done with `string-match',
  4747. if a match began at index 0 in the string.
  4748.  
  4749. arguments:()
  4750. Fstore-match-data
  4751. Set internal data on last search match from elements of LIST.
  4752. LIST should have been created by calling match-data previously.
  4753.  
  4754. arguments:(list)
  4755. Fregexp-quote
  4756. Return a regexp string which matches exactly STRING and nothing else.
  4757.  
  4758. arguments:(str)
  4759. Fsyntax-table-p
  4760. Return t if ARG is a syntax table.
  4761. Any vector of 256 elements will do.
  4762.  
  4763. arguments:(obj)
  4764. Fsyntax-table
  4765. Return the current syntax table.
  4766. This is the one specified by the current buffer.
  4767.  
  4768. arguments:()
  4769. Fstandard-syntax-table
  4770. Return the standard syntax table.
  4771. This is the one used for new buffers.
  4772.  
  4773. arguments:()
  4774. Fcopy-syntax-table
  4775. Construct a new syntax table and return it.
  4776. It is a copy of the TABLE, which defaults to the standard syntax table.
  4777.  
  4778. arguments:(&optional table)
  4779. Fset-syntax-table
  4780. Select a new syntax table for the current buffer.
  4781. One argument, a syntax table.
  4782.  
  4783. arguments:(table)
  4784. Fchar-syntax
  4785. Return the syntax code of CHAR, described by a character.
  4786. For example, if CHAR is a word constituent, the character `?w' is returned.
  4787. The characters that correspond to various syntax codes
  4788. are listed in the documentation of `modify-syntax-entry'.
  4789.  
  4790. arguments:(ch)
  4791. Fmodify-syntax-entry
  4792. Set syntax for character CHAR according to string S.
  4793. The syntax is changed only for table TABLE, which defaults to
  4794.  the current buffer's syntax table.
  4795. The first character of S should be one of the following:
  4796.   Space    whitespace syntax.    w   word constituent.
  4797.   _        symbol constituent.   .   punctuation.
  4798.   (        open-parenthesis.     )   close-parenthesis.
  4799.   "        string quote.         \   character-quote.
  4800.   $        paired delimiter.     '   expression quote or prefix operator.
  4801.   <       comment starter.     >   comment ender.
  4802. Only single-character comment start and end sequences are represented thus.
  4803. Two-character sequences are represented as described below.
  4804. The second character of S is the matching parenthesis,
  4805.  used only if the first character is `(' or `)'.
  4806. Any additional characters are flags.
  4807. Defined flags are the characters 1, 2, 3, 4, 5, 6, 7, 8, p, a, and b.
  4808.  1 means C is the first of a two-char comment start sequence of style a.
  4809.  2 means C is the second character of such a sequence.
  4810.  3 means C is the first of a two-char comment end sequence of style a.
  4811.  4 means C is the second character of such a sequence.
  4812.  5 means C is the first of a two-char comment start sequence of style b.
  4813.  6 means C is the second character of such a sequence.
  4814.  7 means C is the first of a two-char comment end sequence of style b.
  4815.  8 means C is the second character of such a sequence.
  4816.  p means C is a prefix character for `backward-prefix-chars';
  4817.    such characters are treated as whitespace when they occur
  4818.    between expressions.
  4819.  a means C is comment starter or comment ender for comment style a (default)
  4820.  b means C is comment starter or comment ender for comment style b.
  4821.  
  4822. arguments:(c newentry syntax_table)
  4823. Fdescribe-syntax
  4824. Describe the syntax specifications in the syntax table.
  4825. The descriptions are inserted in a buffer, which is then displayed.
  4826.  
  4827. arguments:()
  4828. Fforward-word
  4829. Move point forward ARG words (backward if ARG is negative).
  4830. Normally returns t.
  4831. If an edge of the buffer is reached, point is left there
  4832. and nil is returned.
  4833.  
  4834. arguments:(count)
  4835. Fbackward-syntactic-ws
  4836. Move point backward over all syntactic whitespace.
  4837. This includes all chars with "whitespace" syntax (Space), and, if
  4838. parse-sexp-ignore-comments is non-nil, all characters within comments.
  4839.  
  4840. arguments:()
  4841. Fforward-syntactic-ws
  4842. Move point forward over all syntactic whitespace.
  4843. This includes all chars with "whitespace" syntax (Space), and, if
  4844. parse-sexp-ignore-comments is non-nil, all characters within comments.
  4845.  
  4846. arguments:()
  4847. Fscan-lists
  4848. Scan from character number FROM by COUNT lists.
  4849. Returns the character number of the position thus found.
  4850.  
  4851. If DEPTH is nonzero, paren depth begins counting from that value,
  4852. only places where the depth in parentheses becomes zero
  4853. are candidates for stopping; COUNT such places are counted.
  4854. Thus, a positive value for DEPTH means go out levels.
  4855.  
  4856. Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
  4857.  
  4858. If the beginning or end of (the accessible part of) the buffer is reached
  4859. and the depth is wrong, an error is signaled.
  4860. If the depth is right but the count is not used up, nil is returned.
  4861.  
  4862. arguments:(from count depth)
  4863. Fscan-sexps
  4864. Scan from character number FROM by COUNT balanced expressions.
  4865. If COUNT is negative, scan backwards.
  4866. Returns the character number of the position thus found.
  4867.  
  4868. Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
  4869.  
  4870. If the beginning or end of (the accessible part of) the buffer is reached
  4871. in the middle of a parenthetical grouping, an error is signaled.
  4872. If the beginning or end is reached between groupings
  4873. but before count is used up, nil is returned.
  4874.  
  4875. arguments:(from count)
  4876. Fbackward-prefix-chars
  4877. Move point backward over any number of chars with prefix syntax.
  4878. This includes chars with "quote" or "prefix" syntax (' or p).
  4879.  
  4880. arguments:()
  4881. Fparse-partial-sexp
  4882. Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
  4883. Parsing stops at TO or when certain criteria are met;
  4884.  point is set to where parsing stops.
  4885. If fifth arg STATE is omitted or nil,
  4886.  parsing assumes that FROM is the beginning of a function.
  4887. Value is a list of eight elements describing final state of parsing:
  4888.  1. depth in parens.
  4889.  2. character address of start of innermost containing list; nil if none.
  4890.  3. character address of start of last complete sexp terminated.
  4891.  4. non-nil if inside a string.
  4892.     (it is the character that will terminate the string.)
  4893.  5. t if inside a comment.
  4894.  6. t if following a quote character.
  4895.  7. the minimum paren-depth encountered during this scan.
  4896.  8. nil if in comment style a, or not in a comment; t if in comment style b
  4897. If third arg TARGETDEPTH is non-nil, parsing stops if the depth
  4898. in parentheses becomes equal to TARGETDEPTH.
  4899. Fourth arg STOPBEFORE non-nil means stop when come to
  4900.  any character that starts a sexp.
  4901. Fifth arg STATE is a seven-list like what this function returns.
  4902. It is used to initialize the state of the parse.
  4903.  
  4904. arguments:(from to &optional targetdepth stopbefore oldstate)
  4905. Vparse-sexp-ignore-comments
  4906. Non-nil means `forward-sexp', etc., should treat comments as whitespace.Vwords-include-escapes
  4907. Non-nil means `forward-word', etc., should treat escape chars part of words.Fundo-boundary
  4908. Mark a boundary between units of undo.
  4909. An undo command will stop at this point,
  4910. but another undo command will undo to the previous boundary.
  4911.  
  4912. arguments:()
  4913. Fprimitive-undo
  4914. Undo N records from the front of the list LIST.
  4915. Return what remains of the list.
  4916.  
  4917. arguments:(count list)
  4918. V   inside-undo
  4919. internal variable used to control undoFwindowp
  4920. Returns t if OBJ is a window.
  4921.  
  4922. arguments:(obj)
  4923. Fselected-window
  4924. Return the window that the cursor now appears in and commands apply to.
  4925.  
  4926. arguments:()
  4927. Fminibuffer-window
  4928. Return the window used now for minibuffers.
  4929.  
  4930. arguments:()
  4931. Fwindow-minibuffer-p
  4932. Returns non-nil if WINDOW is a minibuffer window.
  4933.  
  4934. arguments:(window)
  4935. Fpos-visible-in-window-p
  4936. Return t if position POS is currently on the screen in WINDOW.
  4937. Returns nil if that position is scrolled vertically out of view.
  4938. POS defaults to point; WINDOW, to the selected window.
  4939.  
  4940. arguments:(&optional pos window)
  4941. Fwindow-buffer
  4942. Return the buffer that WINDOW is displaying.
  4943.  
  4944. arguments:(&optional window)
  4945. Fwindow-height
  4946. Return the number of lines in WINDOW (including its mode line).
  4947.  
  4948. arguments:(&optional window)
  4949. Fwindow-width
  4950. Return the number of columns in WINDOW.
  4951.  
  4952. arguments:(&optional window)
  4953. Fwindow-hscroll
  4954. Return the number of columns by which WINDOW is scrolled from left margin.
  4955.  
  4956. arguments:(&optional window)
  4957. Fset-window-hscroll
  4958. Set number of columns WINDOW is scrolled from left margin to NCOL.
  4959. NCOL should be zero or positive.
  4960.  
  4961. arguments:(window ncol)
  4962. Fwindow-edges
  4963. Return a list of the edge coordinates of WINDOW.
  4964. (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of screen.
  4965. RIGHT is one more than the rightmost column used by WINDOW,
  4966. and BOTTOM is one more than the bottommost row used by WINDOW
  4967.  and its mode-line.
  4968.  
  4969. arguments:(&optional window)
  4970. Fwindow-point
  4971. Return current value of point in WINDOW.
  4972. For a nonselected window, this is the value point would have
  4973. if that window were selected.
  4974.  
  4975. Note that, when WINDOW is the selected window and its buffer
  4976. is also currently selected, the value returned is the same as (point).
  4977. It would be more strictly correct to return the `top-level' value
  4978. of point, outside of any save-excursion forms.
  4979. But that is hard to define.
  4980.  
  4981. arguments:(&optional window)
  4982. Fwindow-start
  4983. Return position at which display currently starts in WINDOW.
  4984.  
  4985. arguments:(&optional window)
  4986. Fwindow-end
  4987. Return position at which display currently ends in WINDOW.
  4988.  
  4989. arguments:(&optional window)
  4990. Fset-window-point
  4991. Make point value in WINDOW be at position POS in WINDOW's buffer.
  4992.  
  4993. arguments:(window pos)
  4994. Fset-window-start
  4995. Make display in WINDOW start at position POS in WINDOW's buffer.
  4996. Optional third arg NOFORCE non-nil inhibits next redisplay
  4997. from overriding motion of point in order to display at this exact start.
  4998.  
  4999. arguments:(window pos &optional noforce)
  5000. Fwindow-dedicated-p
  5001. Return WINDOW's dedicated object, usually t or nil.
  5002. See also `set-window-buffer-dedicated'.
  5003.  
  5004. arguments:(window)
  5005. Fset-window-buffer-dedicated
  5006. Make WINDOW display BUFFER and be dedicated to that buffer.
  5007. Then Emacs will not automatically change which buffer appears in WINDOW.
  5008. If BUFFER is nil, make WINDOW not be dedicated (but don't change which
  5009. buffer appears in it currently).
  5010.  
  5011. arguments:(window arg)
  5012. Fwindow-display-table
  5013. Return the display-table that WINDOW is using.
  5014.  
  5015. arguments:(&optional window)
  5016. Fset-window-display-table
  5017. Set WINDOW's display-table to TABLE.
  5018.  
  5019. arguments:(window table)
  5020. Fdelete-window
  5021. Remove WINDOW from the display.  Default is selected window.
  5022. If window is the only one on the screen, the screen is destroyed.
  5023.  
  5024. arguments:(&optional window)
  5025. Fnext-window
  5026. Return next window after WINDOW in canonical ordering of windows.
  5027. Optional second arg MINIBUF t means count the minibuffer window
  5028. even if not active.  If MINIBUF is neither t nor nil it means
  5029. not to count the minibuffer even if it is active.
  5030. Optional third arg ALL-SCREENS t means include all windows in all visible
  5031. screens; otherwise cycle within the selected screen, with the exception that
  5032. if a global minibuffer screen is in use, all screens are used.
  5033. Optional fourth argument INVISIBLE-TOO t means also visit invisible screens.
  5034.  
  5035. arguments:(&optional window mini all_screens invisible_too)
  5036. Fprevious-window
  5037. Return previous window before WINDOW in canonical ordering of windows.
  5038. Optional second arg MINIBUF t means count the minibuffer window
  5039. even if not active.  If MINIBUF is neither t nor nil it means
  5040. not to count the minibuffer even if it is active.
  5041. Optional third arg ALL-SCREENS t means include all windows in all visible
  5042. screens; otherwise cycle within the selected screen, with the exception
  5043. that if a global minibuffer screen is in use, all visible screens are used.
  5044. If optional fourth argument INVISIBLE-TOO is t also visit invisible screens.
  5045.  
  5046. arguments:(&optional window mini all_screens invisible_too)
  5047. Fother-window
  5048. Select the ARG'th different window on this screen.
  5049. All windows on current screen are arranged in a cyclic order.
  5050. This command selects the window ARG steps away in that order.
  5051. A negative ARG moves in the opposite order.  If the optional second
  5052. argument ALL_SCREENS is non-nil, cycle through all visible screens.
  5053. If optional third argument INVISIBLE-TOO is t also search invisible screens.
  5054.  
  5055. arguments:(n &optional all_screens invisible_too)
  5056. Fget-lru-window
  5057. Return the window least recently selected or used for display.
  5058. If optional argument SCREENS is non-nil, search only that screen.
  5059.  
  5060. arguments:(&optional screens)
  5061. Fget-largest-window
  5062. Return the window largest in area.  If optional argument SCREENS
  5063. is non-nil, search only that screen.
  5064.  
  5065. arguments:(&optional screens)
  5066. Fget-buffer-window
  5067. Return a window currently displaying BUFFER, or nil if none.
  5068. Only the selected screen is searched; if the optional second argument
  5069. SCREEN is non-nil, then that screen is searched instead.  If SCREEN is t,
  5070. then all visible screens are searched.  If FORCE is t invisible screens
  5071. are searched too.
  5072.  
  5073. arguments:(buffer &optional screen force)
  5074. Fdelete-other-windows
  5075. Make WINDOW (or the selected window) fill its screen.
  5076.  
  5077. arguments:(&optional window)
  5078. Fdelete-windows-on
  5079. Delete all windows showing BUFFER.
  5080.  
  5081. arguments:(buffer)
  5082. Freplace-buffer-in-windows
  5083. Replace BUFFER with some other buffer in all windows showing it.
  5084.  
  5085. arguments:(buffer)
  5086. Fset-window-buffer
  5087. Make WINDOW display BUFFER as its contents.
  5088. BUFFER can be a buffer or buffer name.
  5089.  
  5090. arguments:(window buffer)
  5091. Fselect-window
  5092. Select WINDOW.  Most editing will apply to WINDOW's buffer.
  5093. The main editor command loop selects the buffer of the selected window
  5094. before each command.
  5095.  
  5096. arguments:(window)
  5097. Fdisplay-buffer
  5098. Make BUFFER appear in some window on the current screen, but don't select it.
  5099. BUFFER can be a buffer or a buffer name.
  5100. If BUFFER is shown already in some window in the current screen, just uses
  5101.  that one, unless the window is the selected window and NOT_THIS_WINDOW_P
  5102.  is non-nil.
  5103. If ON_SCREEN is non-nil, display on that screen instead of the current
  5104.  screen (or the dedicated screen).
  5105. If BUFFER has a dedicated screen, display on that screen instead of the
  5106.  current screen, unless ON_SCREEN was specified.
  5107. If pop-up-windows is non-nil, and the buffer is not visible in some window
  5108.  on the target screen, then windows will be split (a new window will be
  5109.  created) if there is room.  Otherwise, the least-recently-used window will
  5110.  be reused.
  5111. Returns the window displaying BUFFER.
  5112.  
  5113. arguments:(buffer &optional not_this_window_p on_screen)
  5114. Fsplit-window
  5115. Split WINDOW, putting SIZE lines in the first of the pair.
  5116. WINDOW defaults to selected one and SIZE to half its size.
  5117. If optional third arg HOR-FLAG is non-nil, split side by side
  5118. and put SIZE columns in the first of the pair.
  5119.  
  5120. arguments:(&optional window chsize horflag)
  5121. Fenlarge-window
  5122. Make current window ARG lines bigger.
  5123. From program, optional second arg non-nil means grow sideways ARG columns.
  5124.  
  5125. arguments:(n &optional side)
  5126. Fshrink-window
  5127. Make current window ARG lines smaller.
  5128. From program, optional second arg non-nil means shrink sideways ARG columns.
  5129.  
  5130. arguments:(n &optional side)
  5131. Fscroll-up
  5132. Scroll text of current window upward ARG lines; or near full screen if no ARG.
  5133. A near full screen is `next-screen-context-lines' less than a full screen.
  5134. When calling from a program, supply a number as argument or nil.
  5135.  
  5136. arguments:(&optional n)
  5137. Fscroll-down
  5138. Scroll text of current window downward ARG lines; or near full screen if no ARG.
  5139. A near full screen is `next-screen-context-lines' less than a full screen.
  5140. When calling from a program, supply a number as argument or nil.
  5141.  
  5142. arguments:(&optional n)
  5143. Fscroll-other-window
  5144. Scroll text of next window upward ARG lines; or near full screen if no ARG.
  5145. The next window is the one below the current one; or the one at the top
  5146. if the current one is at the bottom.
  5147. When calling from a program, supply a number as argument or nil.
  5148.  
  5149. If in the minibuffer, `minibuf-scroll-window' if non-nil
  5150. specifies the window to scroll.
  5151. If `other-window-scroll-buffer' is non-nil, scroll the window
  5152. showing that buffer, popping the buffer up if necessary.
  5153.  
  5154. arguments:(&optional n)
  5155. Fscroll-left
  5156. Scroll selected window display ARG columns left.
  5157. Default for ARG is window width minus 2.
  5158.  
  5159. arguments:(arg)
  5160. Fscroll-right
  5161. Scroll selected window display ARG columns right.
  5162. Default for ARG is window width minus 2.
  5163.  
  5164. arguments:(arg)
  5165. Frecenter
  5166. Center point in window and redisplay screen.  With ARG, put point on line ARG.
  5167. The desired position of point is always relative to the current window.
  5168. Just C-u as prefix means put point in the center of the screen.
  5169. No arg (i.e., it is nil) erases the entire screen and then
  5170. redraws with point in the center.
  5171.  
  5172. arguments:(&optional n)
  5173. Fmove-to-window-line
  5174. Position point relative to window.
  5175. With no argument, position text at center of window.
  5176. An argument specifies screen line; zero means top of window,
  5177. negative means relative to bottom of window.
  5178.  
  5179. arguments:(arg)
  5180. Fset-window-configuration
  5181. Set the configuration of windows and buffers as specified by CONFIGURATION.
  5182. CONFIGURATION must be a value previously returned
  5183. by `current-window-configuration' (which see).
  5184.  
  5185. arguments:(arg)
  5186. Fcurrent-window-configuration
  5187. Return an object representing Emacs' current window configuration.
  5188. This describes the number of windows, their sizes and current buffers,
  5189. and for each displayed buffer, where display starts, and the positions of
  5190. point and mark.  An exception is made for point in the current buffer:
  5191. its value is -not- saved.
  5192.  
  5193. arguments:()
  5194. Fsave-window-excursion
  5195. Execute body, preserving window sizes and contents.
  5196. Restores which buffer appears in which window, where display starts,
  5197. as well as the current buffer.
  5198. Does not restore the value of point in current buffer.
  5199.  
  5200. arguments: (&rest args)
  5201. Vtemp-buffer-show-function
  5202. Non-nil means call as function to display a help buffer.
  5203. Used by `with-output-to-temp-buffer'.Vdisplay-buffer-function
  5204. If non-nil, function to call to handle `display-buffer'.
  5205. It will receive three args, the same args as display-buffer.Vpre-display-buffer-function
  5206. If non-nil, function that will be called from `display-buffer' as the
  5207. first action.  It will receive three args, the same arguments as 
  5208. `display-buffer' -- the buffer, a flag which if non-nil means that the
  5209. currently selected window is not acceptable, and a screen to use (or nil,
  5210. meaning unspecified.)  This function may be used to select an appropriate
  5211. screen for the buffer, for example.  See also the variable
  5212. `display-buffer-function', which may be used to completely replace
  5213. display-buffer.Vminibuffer-scroll-window
  5214. Non-nil means it is the window that C-M-v in minibuffer should scroll.Vother-window-scroll-buffer
  5215. If non-nil, this is a buffer and \[scroll-other-window] should scroll its window.Vpop-up-windows
  5216. *Non-nil means display-buffer should make new windows.Vnext-screen-context-lines
  5217. *Number of lines of continuity when scrolling by screenfuls.Vsplit-height-threshold
  5218. *display-buffer would prefer to split the largest window if this large.
  5219. If there is only one window, it is split regardless of this value.Vwindow-min-height
  5220. *Delete any window less than this tall (including its mode line).Vwindow-min-width
  5221. *Delete any window less than this wide.Fredraw-screen
  5222. Clear screen SCREEN and output again what is supposed to appear on it.
  5223.  
  5224. arguments:(screen)
  5225. Fredraw-display
  5226. Redraw all screens marked as having their images garbled.
  5227.  
  5228. arguments:()
  5229. Fredraw-display
  5230. Clear the screen and output again what is supposed to appear on it.
  5231.  
  5232. arguments:()
  5233. Vglobal-mode-string
  5234. String displayed by mode-line-format's "%m" specification.Voverlay-arrow-position
  5235. Marker for where to display an arrow on top of the buffer text.
  5236. This must be the beginning of a line in order to work.
  5237. See also `overlay-arrow-string'.Voverlay-arrow-string
  5238. String to display as an arrow.  See also `overlay-arrow-position'.Vscroll-step
  5239. *The number of lines to try scrolling a window by when point moves out.
  5240. If that fails to bring point back on screen, point is centered instead.
  5241. If this is zero, point is always centered after it moves off screen.Vtruncate-partial-width-windows
  5242. *Non-nil means truncate lines in all windows less than full screen wide.Vmode-line-inverse-video
  5243. *Non-nil means use inverse video for the mode line.Vscreen-title-format
  5244. Controls the title of the X window corresponding to the selected screen.
  5245. This is the same format as `mode-line-format'.Vscreen-icon-title-format
  5246. Controls the title of the icon corresponding to the selected screen.
  5247. See also the variable `screen-title-format'Fenergize-toggle-psheet
  5248.  
  5249.  
  5250. arguments:()
  5251. Fx-create-screen
  5252. Make a new X window, which is considered a "screen" in Emacs terms.
  5253. Return an Emacs screen object representing the X window.
  5254. ALIST is an alist of screen parameters.
  5255. The value of `x-screen-defaults' is an additional alist
  5256. of default parameters which apply when not overridden by ALIST.
  5257. Optional second argument is the numerical ID of the X window to use for this
  5258. screen (in order to run Emacs on a window created by some other program).
  5259. Since this ID number is an unsigned long, you must pass it as a string.
  5260. It may be a string of decimal numbers, or a string of hex numbers beginning
  5261. with "0x".
  5262.  
  5263. arguments:(parms &optional lisp_window_id)
  5264. Fx-focus-screen
  5265. Obsolete function.  Superceded by select-screen
  5266.  
  5267. arguments:(focus_p &optional screen)
  5268. Fx-show-lineinfo-column
  5269. Make the current emacs screen have a lineinfo column.
  5270.  
  5271. arguments:(&optional screen)
  5272. Fx-hide-lineinfo-column
  5273. Make the given emacs screen not have a lineinfo column.
  5274.  
  5275. arguments:(&optional screen)
  5276. Fx-display-visual-class
  5277. Returns the visual class of the display `screen' is on.
  5278. The returned value will be one of the symbols StaticGray, GrayScale,
  5279. StaticColor, PseudoColor, TrueColor, or DirectColor.
  5280.  
  5281. arguments:(&optional screen)
  5282. Fx-color-display-p
  5283. Returns t if the X display of the given screen supports color.
  5284.  
  5285. arguments:(&optional screen)
  5286. Fx-pixel-width
  5287. Returns the width in pixels of the given screen.
  5288.  
  5289. arguments:(&optional screen)
  5290. Fx-pixel-height
  5291. Returns the height in pixels of the given screen.
  5292.  
  5293. arguments:(&optional screen)
  5294. Fx-display-pixel-width
  5295. Returns the width in pixels of the display `screen' is on.
  5296.  
  5297. arguments:(&optional screen)
  5298. Fx-display-pixel-height
  5299. Returns the height in pixels of the display `screen' is on.
  5300.  
  5301. arguments:(&optional screen)
  5302. Fx-display-planes
  5303. Returns the number of bitplanes of the display `screen' is on.
  5304.  
  5305. arguments:(&optional screen)
  5306. Fx-display-color-cells
  5307. Returns the number of color cells of the display `screen' is on.
  5308.  
  5309. arguments:(&optional screen)
  5310. Fx-server-vendor
  5311. Returns the vendor ID string of the X server `screen' is on.
  5312.  
  5313. arguments:(&optional screen)
  5314. Fx-server-version
  5315. Returns the version numbers of the X server `screen' is on.
  5316. The returned value is a list of three integers: the major and minor
  5317. version numbers of the X Protocol in use, and the vendor-specific release
  5318. number.  See also `x-server-vendor'.
  5319.  
  5320. arguments:(&optional screen)
  5321. Fx-set-screen-icon-pixmap
  5322. Set the icon-pixmap of the given screen.
  5323. This should be the name of a bitmap file, or a bitmap description list
  5324. of the form (width height "bitmap-data").
  5325. If the optional third argument is specified, it is the bitmap to use for
  5326. the icon-pixmap-mask (not all window managers obey this.)
  5327. Warning: when you call this function, the pixmap of the previous icon
  5328. of this screen (if any) is currently not freed.
  5329.  
  5330. arguments:(screen pixmap &optional mask)
  5331. Fx-grab-pointer
  5332. Grab the pointer and restrict it to its current window.  If optional
  5333. SHAPE is non-nil, change the pointer shape to that.  If second optional
  5334. argument MOUSE-ONLY is non-nil, ignore keyboard events during the grab.
  5335.  
  5336. arguments:(&optional shape ignore_keyboard)
  5337. Fx-ungrab-pointer
  5338. Release the pointer.
  5339.  
  5340. arguments:()
  5341. Fx-EnterNotify-internal
  5342. hands off
  5343.  
  5344. arguments:(screen)
  5345. Fx-LeaveNotify-internal
  5346. hands off
  5347.  
  5348. arguments:(screen)
  5349. Fx-FocusIn-internal
  5350. hands off
  5351.  
  5352. arguments:(screen)
  5353. Fx-FocusOut-internal
  5354. hands off
  5355.  
  5356. arguments:(screen)
  5357. Fx-VisibilityNotify-internal
  5358. hands off
  5359.  
  5360. arguments:(screen)
  5361. Fx-non-VisibilityNotify-internal
  5362. hands off
  5363.  
  5364. arguments:(screen)
  5365. Fx-MapNotify-internal
  5366. hands off
  5367.  
  5368. arguments:(screen)
  5369. Fx-UnmapNotify-internal
  5370. hands off
  5371.  
  5372. arguments:(screen)
  5373. Fx-rebind-key
  5374. Rebind X keysym KEYSYM, with MODIFIERS, to generate NEWSTRING.
  5375. KEYSYM is a string which conforms to the X keysym definitions found
  5376. in X11/keysymdef.h, sans the initial XK_. MODIFIERS is nil or a
  5377. list of strings specifying modifier keys such as Control_L, which must
  5378. also be depressed for NEWSTRING to appear.
  5379.  
  5380. arguments:(x_keysym modifiers newstring)
  5381. Fx-rebind-keys
  5382. Rebind KEYCODE to list of strings STRINGS.
  5383. STRINGS should be a list of 16 elements, one for each shift combination.
  5384. nil as element means don't change.
  5385. See the documentation of `x-rebind-key' for more information.
  5386.  
  5387. arguments:(keycode strings)
  5388. Fx-get-resource
  5389. Retrieve an X resource from the resource manager.
  5390. The first arg is the name of the resource to retrieve, such as "font".
  5391. The second arg is the class of the resource to retrieve, like "Font".
  5392. The third arg should be one of the symbols string, integer, or boolean,
  5393. specifying the type of object that the database is searched for.
  5394. The fourth arg is the screen to search for the resources on, defaulting
  5395. to the selected screen.
  5396.  
  5397. The call
  5398.     (x-get-resource "font" "Font" 'string)
  5399.  
  5400. is an interface to the C call
  5401.  
  5402.     XrmGetResource (db, "emacs.this_screen_name.font",
  5403.             "Emacs.EmacsScreen.Font",
  5404.             "String");
  5405.  
  5406. Therefore if you want to retrieve a deeper resource, for example,
  5407. "Emacs.foo.foreground", you need to specify the same number of links
  5408. in the class path:
  5409.     (x-get-resource "foo.foreground" "Thing.Foreground" 'string)
  5410.  
  5411. which is equivalent to 
  5412.  
  5413.     XrmGetResource (db, "emacs.screen_name.foo.foreground",
  5414.             "Emacs.EmacsScreen.Thing.Foreground",
  5415.             "String");
  5416.  
  5417.  
  5418. The returned value of this function is nil if the queried resource is not
  5419. found.  If the third arg is `string', a string is returned, and if it is
  5420. `integer', an integer is returned.  If the third arg is `boolean', then the
  5421. returned value is the list (t) for true, (nil) for false, and is nil to
  5422. mean ``unspecified.''
  5423.  
  5424. arguments:(name class type &optional screen)
  5425. Fx-valid-color-name-p
  5426. Returns true if COLOR names a color that X knows about.
  5427. Valid color names are listed in the file /usr/lib/X11/rgb.txt, or
  5428. whatever the equivalent is on your system.
  5429.  
  5430. arguments:(color &optional screen)
  5431. Fx-valid-keysym-name-p
  5432. Returns true if KEYSYM names a keysym that the X library knows about.
  5433. Valid keysyms are listed in the files /usr/include/X11/keysymdef.h and in
  5434. /usr/lib/X11/XKeysymDB, or whatever the equivalents are on your system.
  5435.  
  5436. arguments:(keysym)
  5437. Fx-set-screen-pointer
  5438. Set the mouse cursor of SCREEN to the cursor named CURSOR-NAME,
  5439. with colors FOREGROUND and BACKGROUND.  The string may be any of the
  5440. standard cursor names from appendix B of the Xlib manual (also known as
  5441. the file <X11/cursorfont.h>) minus the XC_ prefix, or it may be a font
  5442. name and glyph index of the form "FONT fontname index [[font] index]",
  5443. or it may be a bitmap file acceptable to XmuLocateBitmapFile().
  5444. If it is a bitmap file, and if a bitmap file whose name is the name of
  5445. the cursor with "msk" exists, then it is used as the mask.  For example,
  5446. a pair of files may be named "cursor.xbm" and "cursor.xbmmsk".
  5447.  
  5448. arguments:(screen cursor_name &optional fg bg)
  5449. Fx-open-connection
  5450. Open a connection to an X server.
  5451. Argument ARGV is a list of strings describing the command line options.
  5452. Returns a copy of ARGV from which the arguments used by the Xt code
  5453. to open the connect have been removed.
  5454.  
  5455. arguments:(argv_list)
  5456. Fx-window-id
  5457. Get the ID of the X11 window. This gives us a chance to manipulate
  5458. the Emacs window from within a different program. Since the id is an
  5459. unsigned long, we return it as a string.
  5460.  
  5461. arguments:(screen)
  5462. Fx-close-current-connection
  5463. Close the connection to the current X server.
  5464.  
  5465. arguments:()
  5466. Fx-debug-mode
  5467. With a true arg, put the connection to the X server in synchronous
  5468. mode; this is slower.  False turns it off.
  5469. Do not simply call XSynchronize() from gdb; that won't work.
  5470.  
  5471. arguments:(arg)
  5472. Vx-gc-pointer-shape
  5473. The shape of the mouse-pointer during garbage collection.
  5474. If this is nil, then the cursor will not be changed, and echo-area messages
  5475. will be used instead.Vbar-cursor
  5476. Use vertical bar cursor if non-nil.Vx-screen-defaults
  5477. Alist of default screen-creation parameters for X-window screens.
  5478. These override what is specified in `~/.Xdefaults' but are overridden
  5479. by the arguments to the particular call to `x-create-screen'.Vdefault-screen-name
  5480. The default name to assign to newly-created screens.
  5481. This can be overridden by arguments to `x-create-screen'.
  5482. This must be a string.Vx-emacs-application-class
  5483. The X application class of the Emacs process.
  5484. This controls, among other things, the name of the `app-defaults' file
  5485. that emacs will use.  For changes to this variable to take effect, they
  5486. must be made before the connection to the X server is initialized, that is,
  5487. this variable may only be changed before emacs is dumped, or by setting it
  5488. in the file lisp/term/x-win.el.Vx-bitmap-file-path
  5489. A list of the directories in which X bitmap files may be found.
  5490. If nil, this is initialized from the "*bitmapFilePath" resource.Vx-allow-sendevents
  5491. *Non-nil means to allow synthetic events.  Nil means they are ignored.
  5492. Beware: allowing emacs to process SendEvents opens a big security hole.Fx-selection-reply-timeout-internal
  5493.  
  5494.  
  5495. arguments:(arg)
  5496. Fx-own-selection-internal
  5497. Assert an X selection of the given TYPE with the given VALUE.
  5498. TYPE is a symbol, typically PRIMARY, SECONDARY, or CLIPBOARD.
  5499. VALUE is typically a string, or a cons of two markers, but may be
  5500. anything that the functions on selection-converter-alist know about.
  5501.  
  5502. arguments:(selection_name selection_value)
  5503. Fx-get-selection-internal
  5504. Return text selected from some X window.
  5505. SELECTION is a symbol, typically PRIMARY, SECONDARY, or CLIPBOARD.
  5506. TYPE is the type of data desired, typically STRING.
  5507.  
  5508. arguments:(selection_symbol target_type)
  5509. Fx-disown-selection-internal
  5510. If we own the named selection, then disown it (make there be no selection).
  5511.  
  5512. arguments:(selection &optional time)
  5513. Fx-selection-owner-p
  5514. Whether the current emacs process owns the given X Selection.
  5515. The arg should be the name of the selection in question, typically one of
  5516. the symbols PRIMARY, SECONDARY, or CLIPBOARD.  (For convenience, the symbol
  5517. nil is the same as PRIMARY, and t is the same as SECONDARY.)
  5518.  
  5519. arguments:(&optional selection)
  5520. Fx-selection-exists-p
  5521. Whether there is an owner for the given X Selection.
  5522. The arg should be the name of the selection in question, typically one of
  5523. the symbols PRIMARY, SECONDARY, or CLIPBOARD.  (For convenience, the symbol
  5524. nil is the same as PRIMARY, and t is the same as SECONDARY.)
  5525.  
  5526. arguments:(&optional selection)
  5527. Fx-get-cutbuffer-internal
  5528. Returns the value of the named cutbuffer (typically CUT_BUFFER0).
  5529.  
  5530. arguments:(buffer)
  5531. Fx-store-cutbuffer-internal
  5532. Sets the value of the named cutbuffer (typically CUT_BUFFER0).
  5533.  
  5534. arguments:(buffer string)
  5535. Fx-rotate-cutbuffers-internal
  5536. Rotate the values of the cutbuffers by the given number of steps;
  5537. positive means move values forward, negative means backward.
  5538.  
  5539. arguments:(n)
  5540. Vselection-converter-alist
  5541. An alist associating selection-types (such as STRING and TIMESTAMP) with
  5542. functions.  These functions will be called with three args: the name of the
  5543. selection (typically PRIMARY, SECONDARY, or CLIPBOARD); a desired type to
  5544. which the selection should be converted; and the local selection value
  5545. (whatever had been passed to `x-own-selection').  These functions should
  5546. return the value to send to the X server (typically a string).  A return
  5547. value of nil means that the conversion could not be done.  A return value
  5548. which is the symbol NULL means that a side-effect was executed, and there
  5549. is no meaningful return value.Vx-lost-selection-hooks
  5550. A function or functions to be called after the X server has notified us
  5551. that we have lost the selection.  The function(s) will be called with one
  5552. argument, a symbol naming the selection (typically PRIMARY, SECONDARY, or
  5553. CLIPBOARD.)Vx-sent-selection-hooks
  5554. A function or functions to be called after we have responded to some
  5555. other client's request for the value of a selection that we own.  The
  5556. function(s) will be called with four arguments:
  5557.   - the name of the selection (typically PRIMARY, SECONDARY, or CLIPBOARD);
  5558.   - the name of the selection-type which we were requested to convert the
  5559.     selection into before sending (for example, STRING or LENGTH);
  5560.   - and whether we successfully transmitted the selection.
  5561. We might have failed (and declined the request) for any number of reasons,
  5562. including being asked for a selection that we no longer own, or being asked
  5563. to convert into a type that we don't know about or that is inappropriate.
  5564. This hook doesn't let you change the behavior of emacs's selection replies,
  5565. it merely informs you that they have happened.Vx-selection-timeout
  5566. If the selection owner doens't reply in this many seconds, we give up.
  5567. A value of 0 means wait as long as necessary.  This is initialized from the
  5568. "*selectionTimeout" resource (which is expressed in milliseconds).
  5569. Vemacs-version
  5570. Version numbers of this version of Emacs.
  5571. Vemacs-build-time
  5572. Time at which Emacs was dumped out.
  5573. Femacs-version
  5574. Return string describing the version of Emacs that is running.
  5575. Vmode-line-buffer-identification
  5576. Mode-line control for identifying the buffer being displayed.
  5577. Its default value is "Emacs: %17b".  Major modes that edit things
  5578. other than ordinary files may change this (e.g. Info, Dired,...)
  5579. Vmode-line-process
  5580. Mode-line control for displaying info on process status.
  5581. Normally nil in most modes, since there is no process to display.
  5582. Vmode-line-modified
  5583. Mode-line control for displaying whether current buffer is modified.
  5584. Vminor-mode-alist
  5585. Alist saying how to show minor modes in the mode line.
  5586. Each element looks like (VARIABLE STRING);
  5587. STRING is included in the mode line iff VARIABLE's value is non-nil.
  5588. Vparagraph-start
  5589. *Regexp for beginning of a line that starts OR separates paragraphs.
  5590. Vparagraph-separate
  5591. *Regexp for beginning of a line that separates paragraphs.
  5592. If you change this, you may have to change paragraph-start also.
  5593. Vsentence-end
  5594. *Regexp describing the end of a sentence.
  5595. All paragraph boundaries also end sentences, regardless.
  5596. Vpage-delimiter
  5597. *Regexp describing line-beginnings that separate pages.
  5598. Vcase-replace
  5599. *Non-nil means query-replace should preserve case in replacements.
  5600. Vindent-line-function
  5601. Function to indent current line.
  5602. Vonly-global-abbrevs
  5603. *t means user plans to use global abbrevs only.
  5604. Makes the commands to define mode-specific abbrevs define global ones instead.
  5605. Vgrep-command
  5606. *Name of the command to use to run the grep command;
  5607. typically "grep -n" or "egrep -n".
  5608. (The "-n" option tells grep to output line numbers.)
  5609. Vdired-listing-switches
  5610. *Switches passed to `ls' for Dired.  MUST contain the `l' option.
  5611. Vlpr-switches
  5612. *List of strings to pass as extra args to `lpr' when it is invoked.
  5613. Vtag-table-alist
  5614. *A list which determines which tags files should be active for a 
  5615. given buffer.  This is not really an association list, in that all 
  5616. elements are checked.  The CAR of each element of this list is a 
  5617. pattern against which the buffer's file name is compared; if it 
  5618. matches, then the CDR of the list should be the name of the tags
  5619. table to use.  If more than one element of this list matches the
  5620. buffer's file name, then all of the associated tags tables will be
  5621. used.  Earlier ones will be searched first.
  5622.  
  5623. If the CAR of elements of this list are strings, then they are treated
  5624. as regular-expressions against which the file is compared (like the
  5625. auto-mode-alist).  If they are not strings, then they are evaluated.
  5626. If they evaluate to non-nil, then the current buffer is considered to
  5627. match.
  5628.  
  5629. If the CDR of the elements of this list are strings, then they are
  5630. assumed to name a TAGS file.  If they name a directory, then the string
  5631. "TAGS" is appended to them to get the file name.  If they are not 
  5632. strings, then they are evaluated, and must return an appropriate string.
  5633.  
  5634. For example:
  5635.   (setq tag-table-alist
  5636.     '(("/usr/src/public/perl/" . "/usr/src/public/perl/perl-3.0/")
  5637.      ("\\.el$" . "/usr/local/emacs/src/")
  5638.      ("/jbw/gnu/" . "/usr15/degree/stud/jbw/gnu/")
  5639.      ("" . "/usr/local/emacs/src/")
  5640.      ))
  5641.  
  5642. This means that anything in the /usr/src/public/perl/ directory should use
  5643. the TAGS file /usr/src/public/perl/perl-3.0/TAGS; and file ending in .el should
  5644. use the TAGS file /usr/local/emacs/src/TAGS; and anything in or below the
  5645. directory /jbw/gnu/ should use the TAGS file /usr15/degree/stud/jbw/gnu/TAGS.
  5646. A file called something like "/usr/jbw/foo.el" would use both the TAGS files
  5647. /usr/local/emacs/src/TAGS and /usr15/degree/stud/jbw/gnu/TAGS (in that order)
  5648. because it matches both patterns.
  5649.  
  5650. If the buffer-local variable `buffer-tag-table' is set, then it names a tags
  5651. table that is searched before all others when find-tag is executed from this
  5652. buffer.
  5653.  
  5654. If there is a file called "TAGS" in the same directory as the file in 
  5655. question, then that tags file will always be used as well (after the
  5656. `buffer-tag-table' but before the tables specified by this list.)
  5657.  
  5658. If the variable tags-file-name is set, then the tags file it names will apply
  5659. to all buffers (for backwards compatibility.)  It is searched first.
  5660.  
  5661. Vtags-file-name
  5662. *The name of the tags-table used by all buffers.
  5663. This is for backward compatibility, and is largely supplanted by the
  5664. variable tag-table-alist.
  5665. Vshell-prompt-pattern
  5666. *Regexp used by Newline command in shell mode to match subshell prompts.
  5667. Anything from beginning of line up to the end of what this pattern matches
  5668. is deemed to be prompt, and is not reexecuted.
  5669. Vledit-save-files
  5670. *Non-nil means Ledit should save files before transferring to Lisp.
  5671. Vledit-go-to-lisp-string
  5672. *Shell commands to execute to resume Lisp job.
  5673. Vledit-go-to-liszt-string
  5674. *Shell commands to execute to resume Lisp compiler job.
  5675. Vdisplay-time-day-and-date
  5676. *Non-nil means M-x display-time should display day and date as well as time.
  5677. Vauto-mode-alist
  5678. Alist of filename patterns vs corresponding major mode functions.
  5679. Each element looks like (REGEXP . FUNCTION).
  5680. Visiting a file whose name matches REGEXP causes FUNCTION to be called.
  5681. Vfont-lock-keywords
  5682. *The keywords to highlight.
  5683. If this is a list, then elements may be of the forms:
  5684.  
  5685.   "string"            ; a regexp to highlight in the 
  5686.                 ;  `font-lock-keyword-face'.
  5687.   ("string" . integer)      ; match N of the regexp will be highlighted
  5688.   ("string" . face-name)    ; use the named face
  5689.   ("string" integer face-name)  ; both of the above
  5690.  
  5691. These regular expressions should not match text which spans lines.  Multi-line
  5692. patterns will be correctly fontified when \[font-lock-fontify-buffer] is used,
  5693. but will not be matched by the auto-fontification that font-lock-mode does,
  5694. since it looks at only one line at a time.
  5695.  
  5696. The more patterns there are in this list, the slower the initial fontification
  5697. of the buffer will be.
  5698. Vdiff-switches
  5699. *A list of switches to pass to the diff program.
  5700. Vkill-emacs-hook
  5701. A list of functions (of no args) for `kill-emacs' to call before emacs is
  5702. actually killed.
  5703. Vrmail-dont-reply-to-names
  5704. *A regular expression specifying names to prune in replying to messages.
  5705. nil means don't reply to yourself.
  5706. Vrmail-default-dont-reply-to-names
  5707. A regular expression specifying part of the value of the default value of
  5708. the variable `rmail-dont-reply-to-names', for when the user does not set
  5709. `rmail-dont-reply-to-names' explicitly.  (The other part of the default
  5710. value is the user's name.)
  5711. It is useful to set this variable in the site customisation file.
  5712. Vrmail-primary-inbox-list
  5713. *List of files which are inboxes for user's primary mail file ~/RMAIL.
  5714. `nil' means the default, which is ("/usr/spool/mail/$USER" "~/mbox")
  5715. (the first name varies depending on the operating system,
  5716. and the value of the environment variable MAIL overrides it).
  5717. Vrmail-ignored-headers
  5718. *Gubbish header fields one would rather not see.
  5719. Vrmail-delete-after-output
  5720. *Non-nil means automatically delete a message that is copied to a file.
  5721. Vauto-save-timeout
  5722. *Number of seconds idle time before auto-save.
  5723. Zero or nil means disable auto-saving due to idleness.
  5724.  
  5725. The actual amount of idle time between auto-saves is logarithmically related
  5726. to the size of the current buffer.  This variable is the number of seconds
  5727. after which an auto-save will happen when the current buffer is 50k or less;
  5728. the timeout will be 2 1/4 times this in a 200k buffer, 3 3/4 times this in a
  5729. 1000k buffer, and 4 1/2 times this in a 2000k buffer.
  5730.  
  5731. For this variable to have any effect, you must do (require 'timer).
  5732.  
  5733. See also the variable `auto-save-interval', which controls auto-saving based
  5734. on the number of characters typed.
  5735. Vsend-mail-function
  5736. Function to call to send the current buffer as mail.
  5737. The headers are delimited by a string found in mail-header-separator.
  5738. Vmail-self-blind
  5739. *Non-nil means insert BCC to self in messages to be sent.
  5740. This is done when the message is initialized,
  5741. so you can remove or alter the BCC field to override the default.
  5742. Vmail-interactive
  5743. *Non-nil means when sending a message wait for and display errors.
  5744. nil means let mailer mail back a message to report errors.
  5745. Vmail-yank-ignored-headers
  5746. Delete these headers from old message when it's inserted in a reply.
  5747. Vmail-header-separator
  5748. *Line used to separate headers from text in messages being composed.
  5749. Vmail-archive-file-name
  5750. *Name of file to write all outgoing messages in, or nil for none.
  5751. Do not use an rmail file here!  Instead, use its inbox file.
  5752. Vmail-signature-file
  5753. File to be inserted at the end of a message. Usually, this file is called
  5754. "~/.signature".
  5755. Vmail-aliases
  5756. Word-abbrev table of mail address aliases.
  5757. If this is nil, it means the aliases have not yet been initialized and
  5758. should be read from the .mailrc file.  (This is distinct from there being
  5759. no aliases, which is represented by this being a table with no entries.)
  5760. Vmail-abbrev-mailrc-file
  5761. Name of file with mail aliases.   If nil, ~/.mailrc is used.
  5762. Vmail-use-rfc822
  5763. *If non-nil, use a full, hairy RFC822 parser on mail addresses.
  5764. Otherwise, (the default) use a smaller, somewhat faster and
  5765. often-correct parser.
  5766. Fquery-replace
  5767. Replace some occurrences of FROM-STRING with TO-STRING.
  5768. As each match is found, the user must type a character saying
  5769. what to do with it.  For directions, type \[help-command] at that time.
  5770.  
  5771. Preserves case in each replacement if  case-replace  and  case-fold-search
  5772. are non-nil and FROM-STRING has no uppercase letters.
  5773. Third arg DELIMITED (prefix arg if interactive) non-nil means replace
  5774. only matches surrounded by word boundaries.
  5775. Fquery-replace-regexp
  5776. Replace some things after point matching REGEXP with TO-STRING.
  5777. As each match is found, the user must type a character saying
  5778. what to do with it.  For directions, type \[help-command] at that time.
  5779.  
  5780. Preserves case in each replacement if  case-replace  and  case-fold-search
  5781. are non-nil and REGEXP has no uppercase letters.
  5782. Third arg DELIMITED (prefix arg if interactive) non-nil means replace
  5783. only matches surrounded by word boundaries.
  5784. In TO-STRING, \& means insert what matched REGEXP,
  5785. and \=\<n> means insert what matched <n>th \(...\) in REGEXP.
  5786. Fmap-query-replace-regexp
  5787. Replace some matches for REGEXP with various strings, in rotation.
  5788. The second argument TO-STRINGS contains the replacement strings, separated
  5789. by spaces.  This command works like `query-replace-regexp' except
  5790. that each successive replacement uses the next successive replacement string,
  5791. wrapping around from the last such string to the first.
  5792.  
  5793. Non-interactively, TO-STRINGS may be a list of replacement strings.
  5794.  
  5795. A prefix argument N says to use each replacement string N times
  5796. before rotating to the next.
  5797. Freplace-string
  5798. Replace occurrences of FROM-STRING with TO-STRING.
  5799. Preserve case in each match if `case-replace' and `case-fold-search'
  5800. are non-nil and FROM-STRING has no uppercase letters.
  5801. Third arg DELIMITED (prefix arg if interactive) non-nil means replace
  5802. only matches surrounded by word boundaries.
  5803.  
  5804. This function is usually the wrong thing to use in a Lisp program.
  5805. What you probably want is a loop like this:
  5806.   (while (search-forward OLD-STRING nil t)
  5807.     (replace-match REPLACEMENT nil t))
  5808. which will run faster and will not set the mark or print anything.
  5809. Freplace-regexp
  5810. Replace things after point matching REGEXP with TO-STRING.
  5811. Preserve case in each match if case-replace and case-fold-search
  5812. are non-nil and REGEXP has no uppercase letters.
  5813. Third arg DELIMITED (prefix arg if interactive) non-nil means replace
  5814. only matches surrounded by word boundaries.
  5815. In TO-STRING, \& means insert what matched REGEXP,
  5816. and \=\<n> means insert what matched <n>th \(...\) in REGEXP.
  5817.  
  5818. This function is usually the wrong thing to use in a Lisp program.
  5819. What you probably want is a loop like this:
  5820.   (while (re-search-forward REGEXP nil t)
  5821.     (replace-match REPLACEMENT nil nil))
  5822. which will run faster and will not set the mark or print anything.
  5823. Fisearch-forward-regexp
  5824. Do incremental search forward for regular expression.
  5825. Like ordinary incremental search except that your input
  5826. is treated as a regexp.  See \[isearch-forward] for more info.
  5827. Fisearch-backward
  5828. Do incremental search backward.
  5829. With a prefix argument, do an incremental regular expression search instead.
  5830. See \[isearch-forward] for more information.
  5831. Fisearch-backward-regexp
  5832. Do incremental search backward for regular expression.
  5833. Like ordinary incremental search except that your input
  5834. is treated as a regexp.  See \[isearch-forward] for more info.